Skip to content

Add docstrings to Environment.py#4802

Merged
bdbaddog merged 2 commits intoSCons:masterfrom
mwichmann:doc/env-docstrings
Dec 23, 2025
Merged

Add docstrings to Environment.py#4802
bdbaddog merged 2 commits intoSCons:masterfrom
mwichmann:doc/env-docstrings

Conversation

@mwichmann
Copy link
Collaborator

All functions, classes and non-dunder methods now have some kind of docstring in SCons/Environment.py. Some of them are minimal, others more complete.

There are no functional changes.

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 RELEASE.txt (and read the README.rst).
  • I have updated the appropriate documentation

All functions, classes and non-dunder methods now have some kind of
docstring in SCons/Environment.py.  Some of them are minimal, others
more complete.

Signed-off-by: Mats Wichmann <mats@linux.com>
@bdbaddog bdbaddog merged commit 396e163 into SCons:master Dec 23, 2025
7 of 9 checks passed
@mwichmann mwichmann added this to the NextRelease milestone Dec 23, 2025
@mwichmann mwichmann deleted the doc/env-docstrings branch December 23, 2025 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants