[issue17972] inspect module docs omits many functions

Change by kernc : -- nosy: +kernc ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue17972] inspect module docs omits many functions

Cheryl Sabella added the comment: issue12317 discusses inspect.getabsfile() -- nosy: +cheryl.sabella ___ Python tracker ___ ___

[issue17972] inspect module docs omits many functions

Lysandros Nikolaou added the comment: ...but then we would have to include them in the docs... should be *but then we would have to include all the public functions in the docs*. -- ___ Python tracker

[issue17972] inspect module docs omits many functions

Lysandros Nikolaou added the comment: I think this issue should be discussed once more. I am not sure it's worth defining __all__, but then we would have to include them in the docs. If you think __all__ should be defined instead, then I could go through the trouble of doing so. Could a

[issue17972] inspect module docs omits many functions

Change by Karthikeyan Singaravelan : -- nosy: +xtreak ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue17972] inspect module docs omits many functions

Change by Matthias Bussonnier : -- keywords: +patch pull_requests: +6644 stage: needs patch -> patch review ___ Python tracker

[issue17972] inspect module docs omits many functions

Matthias Bussonnier added the comment: Just came across the same issue. It think that the exact behavior may depend on functions. IT is also unclear when to use what sometime. For example, `getsource` seem to be preferable to findsource, getsource cannot be

[issue17972] inspect module docs omits many functions

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

R. David Murray added the comment: Just warnings, no docs. We've done this before for other helper functions, but it is always a judgement call whether it is worth the churn. I defer to those people who have actually done work on the module for the answer to that

[issue17972] inspect module docs omits many functions

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

[issue17972] inspect module docs omits many functions

R. David Murray added the comment: I think adding an __all__ in 3.7 would be reasonable. You are right that we can't simply rename them for backward compatibility reasons. We could rename them, and leave a stub function (that calls the renamed function) but issues a

[issue17972] inspect module docs omits many functions

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

[issue17972] inspect module docs omits many functions

Change by Cheryl Sabella : -- dependencies: -Online doc does not include inspect.classify_class_attrs keywords: +easy ___ Python tracker

[issue17972] inspect module docs omits many functions

Change by Anand Reddy Pandikunta : -- nosy: +chillaranand ___ Python tracker ___ ___

[issue17972] inspect module docs omits many functions

Change by Terry J. Reedy : -- type: enhancement -> behavior versions: +Python 3.7 -Python 3.3 ___ Python tracker ___

[issue17972] inspect module docs omits many functions

Change by Martin Panter : -- dependencies: +Online doc does not include inspect.classify_class_attrs ___ Python tracker ___

[issue17972] inspect module docs omits many functions

Changes by Eric Snow ericsnowcurren...@gmail.com: -- nosy: +eric.snow ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue17972 ___ ___ Python-bugs-list

[issue17972] inspect module docs omits many functions

Terry J. Reedy added the comment: I do not know what you mean by 'leak docs' so I changed the title to something that makes more sense. It is possible that these functions are considered private to the module, but then their names should be preceded by '_', or else there should be an

[issue17972] inspect module docs omits many functions

xiaobing jiang added the comment: when I read the memory_profiler source code, I find it using inspect.getblock(). so I check the doc, but can't find the function's doc. these functions are found not in doc. I want to known which function should in doc or not? in inspect module has no