Skip to content

doc: change five functions to appear global-only#4230

Merged
bdbaddog merged 1 commit into
SCons:masterfrom
mwichmann:doc/not-env-methods
Sep 14, 2022
Merged

doc: change five functions to appear global-only#4230
bdbaddog merged 1 commit into
SCons:masterfrom
mwichmann:doc/not-env-methods

Conversation

@mwichmann
Copy link
Copy Markdown
Collaborator

The five functions EnsureSConsVersion, EnsurePythonVersion, Exit, GetLaunchDir, SConscriptChdir were listed as both global and environment functions, but they do nothing in the context of an environment, so marked in the xml as "global". This only changes the presentation in the manpage & userguide appendix, not the behavior.

Minor tweaks in the code around SConscriptChdir - actually use a bool True/False instead of 0/1, and added a couple of type annotations.

Signed-off-by: Mats Wichmann mats@linux.com

Contributor Checklist:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated CHANGES.txt (and read the README.rst)
  • I have updated the appropriate documentation

The five functions EnsureSConsVersion, EnsurePythonVersion, Exit,
GetLaunchDir, SConscriptChdir were listed as both global and
environment functions, but they do nothing in the context of an
environment, so marked in the xml as "global".  This only changes
the presentation in the manpage & userguide appendix, not the behavior.

Minor tweaks in the code around SConscriptChdir - actually use a
bool True/False instead of 0/1, and added a couple of type annotations.

Signed-off-by: Mats Wichmann <mats@linux.com>
@bdbaddog bdbaddog merged commit 344c93b into SCons:master Sep 14, 2022
@mwichmann mwichmann deleted the doc/not-env-methods branch September 14, 2022 20:29
@mwichmann mwichmann added this to the NextRelease milestone Oct 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants