[issue17972] inspect module docs omits many functions

2018-01-14 Thread Paul Rudin
Paul Rudin added the comment: Although formatannotation is undocumented, its actually documented as a default value for one of the parameters of formatargspec, so it does form part of the module's public interface. However formatargspec is deprecated, so it's still OK to

[issue17972] inspect module docs omits many functions

2018-01-05 Thread Paul Rudin
Paul Rudin added the comment: Documenting and generating a deprecation warning also makes them part of the documented public api. Or are you suggesting just the warning without including in the documentation? Incidentally, there are also the classes BlockFinder and EndOfBlock, which are

[issue17972] inspect module docs omits many functions

2018-01-03 Thread Paul Rudin
Paul Rudin 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 cod