Clean up test framework module docstrings#4833
Clean up test framework module docstrings#4833mwichmann wants to merge 1 commit intoSCons:masterfrom
Conversation
Also a couple of typing additions and docstring changes in TestSCons. No functional changes. Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
added
the
testsuite
| # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. | ||
| # | ||
| # Python License: https://docs.python.org/3/license.html#psf-license | ||
| # |
There was a problem hiding this comment.
Not sure the question... that was there ("under the same terms as Python itself") and we haven't gotten it reclicensed to be under the same terms as the rest of SCons.
There was a problem hiding this comment.
this bit
# This copy is vendored for the SCons project from a revision marked
# "TestCommon.py 1.3.D001 2010/06/03 12:58:27 knight"```
There was a problem hiding this comment.
an attempt to explain that we've continued to change it, while it still has an old version string in it. Our current version isn't "1.3.D001", we couldn't even produce such a version from git... you can see those lines elsewhere in the two files.
There was a problem hiding this comment.
I think we can just remove those. My guess it was the old "__VERSION"... string which got populated and checked in when it shouldn't have.
There was a problem hiding this comment.
happy to remove. those two layers are made to seem as if they were developed indepenedently and just included in SCons as one of multiple projects that used it. If there ever were others I doubt they still are, so we could recast that whole tone - but I certainy wasn't going to presume that much.
There was a problem hiding this comment.
If I had to guess.. some of this code originated with QMtest which was the original framework used. But I could wrong and this code is the result of removing the need to have QMtest..
|
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. |
2 participants
Also a couple of typing additions and docstring changes in TestSCons. No functional changes.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).