docs: document differences between config_lookup and typed lookups (#242) - #297
Merged
hyperrealm merged 1 commit intoSep 9, 2026
Merged
Conversation
Owner
|
Thanks for adding this! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the documentation to clarify the distinction and historical context between path-based lookups (
config_lookup) and typed lookups (config_lookup_int, etc.), as requested in issue #242.Changes Made
libconfig.texiexplaining thatconfig_lookupreturns a pointer to the setting structure, allowing for further traversal or type checking.config_lookup_int) are convenience wrappers that combine path resolution and type conversion into a single step.Why this is important
Users often confuse when to use the generic lookup versus the typed lookup. Documenting this "historical" design choice helps clarify that typed lookups are essentially syntactic sugar for
config_lookupfollowed bysetting_get_*, while the generic lookup offers more flexibility for complex structures.Fixes #242