Updates for Export/Import doc #4417
Merged
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
Mention mutable objects - if an sconscript imports a previously exported variable, it is the same object, so changes propagete. Some wording tweaks in SConscript function. Signed-off-by: Mats Wichmann <[email protected]>
bdbaddog
reviewed
Sep 22, 2023
SCons/Script/SConscript.xml
Outdated
| imported by other SConscript files. | ||
| Exports variables for sharing with other SConscript files. | ||
| The variables are added to a global collection where | ||
| they can be imported by another SConscript file. |
There was a problem hiding this comment.
I think other file(s) is more accurate here?
bdbaddog
reviewed
Sep 22, 2023
SCons/Script/SConscript.xml
Outdated
| @@ -372,7 +400,7 @@ Return('val1 val2') | |||
|
|
|||
| <scons_function name="SConscript"> | |||
| <arguments> | |||
| (scripts, [exports, variant_dir, duplicate, must_exist]) | |||
| (scriptname, [exports, variant_dir, duplicate, must_exist]) | |||
There was a problem hiding this comment.
scriptnames? It can be plural right?
There was a problem hiding this comment.
was trying to match up with wording. as noted elsewhere, unnamed args aren't really helpful in doc generation etc. but we have a good number spread around. SConscript is a weird function, can take 0, 1 or 2 positional args. the 0 part being a bit odd...
There was a problem hiding this comment.
and yes, pluralizing it is ok, if you prefer that.
There was a problem hiding this comment.
I think pluralizing would be better. though I think rarely used, it is accurate.
Signed-off-by: Mats Wichmann <[email protected]>
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.
Mention mutable objects - if an Sconscript imports a previously exported variable, it is the same object, so changes propagate. Some wording tweaks in SConscript function.
Doc-only change.
Contributor Checklist:
CHANGES.txt(and read theREADME.rst)