summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/SCons.Util.rst
Commit message (Collapse)AuthorAgeFilesLines
* API Docs build adjustment.Mats Wichmann2024-05-161-2/+21
| | | | | | | | | | | | | | | For a "package" which has a main piece and submodules, the main part is now processed before, rather than after, the submodules. Usally there's introductory material (e.g. in the main module's docstring) and it's more useful for this to appear at the top of a page rather than down after all the submodules. Made some docstring tweaks in two modules where the result didn't look very good - Debug and PathList. For PathList, Sphinx doesn't process both a class docstring and its __init__ method's docstring - you get one of the other, so joined those together. Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweak Util moduleMats Wichmann2023-09-191-0/+36
Move UtilTests.py from the top level to the Util package directory, for consistency with the other packages with unittests. Renamed Util/types.py -> Util/sctypes.py. types is the name of a stdlib module and it's a bad idea to duplicate it, even though in this case it's "legal" since the file was not at the top level. (Moving UtilTests.py actually made this a real problem) Class Selector is no longer an OrderedDict, it just inherits from dict as ordering is now preserved and we never used any extra features of OrderedDict. Fix API doc build - was missing a good bit of Util since it was split into a package. Moved the import-loop warning to the top of __init__.py so it will be more visible. Fiddly linting, doc-stringing, etc. Super-fiddly: pylint flags foo, bar and baz as prohibited variable/function/method names. Actually changed these in UtilTests.py. SCons.Errors has been a source of import loops because it imports Util. Now Util is split, directly import from the Util.sctypes submodule the two things Errors needs - this may reduce the chance of import problems. Signed-off-by: Mats Wichmann <mats@linux.com>