Update Dictionary documentation to match implementation [ci skip] #3423
Conversation
This file contains 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
Dictionary is now described as returning a dict only if called with no arguments; if called with arguments it returns a string or list of strings (matching the implmenentation). Note env.Dump() only takes zero arguments or one, it it not documented as taking the multiple keys, so there's less ambiguity with it. Some examples twiddled a little, and in a couple of cases Dictionary is not used any longer - we might as well just index into the construction environment since that works. Fixes SCons#3156 Signed-off-by: Mats Wichmann <mats@linux.com>
And replaces some written out "construction environment" and "construction variable" uses with existin entities. Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
force-pushed
the
Dictionary-doc
branch
from
ce51955
to
513264f
Compare
3 tasks
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.
Dictionaryis now described as returning a dict only if called with no arguments; if called with arguments it returns a string or list of strings (matching the implementation).Note
env.Dumponly takes zero arguments or one, it it not documented as taking the multiple keys, so there's less ambiguity with it. It doesn't say it only returns the string value with one arg, but the example shows it doing so, so no change made here.Some examples twiddled a little, and in a couple of cases
Dictionaryis not used any longer - we might as well just index into the construction environment since that works.Fixes #3156
Signed-off-by: Mats Wichmann mats@linux.com
Contributor Checklist:
master/src/CHANGES.txtdirectory (and read theREADME.txtin that directory)Doc-only change.