[docs] [issue17972] inspect module docs omits many functions
report at bugs.python.org
Thu Jan 4 02:51:34 EST 2018
Paul Rudin <paul at rudin.co.uk> added the comment:
If some are to be considered private then the questions are: which ones and how to fix. Presumably renaming to start with "_" might break existing code, so maybe adding an __all__, and just including the public objects is better? That could break code existing relying on * imports I suppose. Deprecation is another possibility, although feels a little odd for things never documented.
formatannotation and formatannotationrelativeto look like a helper functions for formatargspec and are probably not intended as part of the public interface.
Similarly walktree looks like a helper for getclasstree (and its docstring describes it as such).
Python tracker <report at bugs.python.org>
More information about the docs