Skip to content

Clean up test framework module docstrings#4833

Merged
bdbaddog merged 2 commits intoSCons:masterfrom
mwichmann:testing-mod-docstrings
Mar 11, 2026
Merged

Clean up test framework module docstrings#4833
bdbaddog merged 2 commits intoSCons:masterfrom
mwichmann:testing-mod-docstrings

Conversation

@mwichmann
Copy link
Copy Markdown
Collaborator

Also a couple of typing additions and docstring changes in TestSCons. 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

Also a couple of typing additions and docstring changes in TestSCons.
No functional changes.

Signed-off-by: Mats Wichmann <mats@linux.com>
@mwichmann mwichmann added the testsuite Things that only affect the SCons testing. Do not use just because a PR has tests. label Mar 2, 2026
Comment thread testing/framework/TestCommon.py Outdated
@bdbaddog
Copy link
Copy Markdown
Contributor

bdbaddog commented Mar 9, 2026

Is it worth adding the subclass of subclass of? If we generate API docs via Sphinx won't it explain that automaticaly?

@mwichmann
Copy link
Copy Markdown
Collaborator Author

Is it worth adding the subclass of subclass of? If we generate API docs via Sphinx won't it explain that automaticaly?

maybe not worth it... but we don't currently produce API docs of testfw.

Signed-off-by: Mats Wichmann <mats@linux.com>
@bdbaddog bdbaddog merged commit 7c86b9f into SCons:master Mar 11, 2026
9 of 11 checks passed
@mwichmann mwichmann added this to the NextRelease milestone Mar 11, 2026
@mwichmann mwichmann deleted the testing-mod-docstrings branch March 11, 2026 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

testsuite Things that only affect the SCons testing. Do not use just because a PR has tests.

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants