[issue15151] Documentation for Signature, Parameter and signature in inspect module
New submission from Nick Coghlan <ncoghlan@gmail.com>: The PEP 362 implementation has been committed, but the inspect module documentation still needs to be updated. ---------- assignee: docs@python components: Documentation messages: 163534 nosy: docs@python, ncoghlan priority: deferred blocker severity: normal status: open title: Documentation for Signature, Parameter and signature in inspect module versions: Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Georg Brandl <georg@python.org> added the comment: Moving back to blocker for beta2. ---------- nosy: +georg.brandl priority: deferred blocker -> release blocker _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- nosy: +Yury.Selivanov, larry, yselivanov _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Larry Hastings <larry@hastings.org> added the comment: Is anyone working on this? I could possibly take a stab at it tonight, if I get the evening to myself. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Yury Selivanov <yselivanov.ml@gmail.com> added the comment: Larry, Brett, I compiled the documentation from the PEP (attached as inspect.pep362.1.patch). Please take a look and feel free to add/edit. ---------- keywords: +patch Added file: http://bugs.python.org/file26410/inspect.pep362.1.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Changes by Yury Selivanov <yselivanov.ml@gmail.com>: ---------- nosy: -Yury.Selivanov _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Yury Selivanov <yselivanov.ml@gmail.com> added the comment: The new patch version (inspect.pep362.2.patch) includes more examples and includes recommendations to use the Signature Object instead of 'inspect.getfullargsspec'. Please review. ---------- Added file: http://bugs.python.org/file26419/inspect.pep362.2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Yury Selivanov <yselivanov.ml@gmail.com> added the comment: New patch version - inspect.pep362.3.patch I decided to put the new doc section above the "Classes and functions". The new section is now called "Introspecting callables with Signature Object". Aside from that everything is the same as in the 2nd patch. ---------- Added file: http://bugs.python.org/file26420/inspect.pep362.3.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Georg Brandl <georg@python.org> added the comment: Docs issues won't block b2. ---------- priority: release blocker -> deferred blocker _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Changes by Brett Cannon <brett@python.org>: ---------- nosy: +brett.cannon _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Andrew Svetlov added the comment: Yury, please updete your patch to pass doctest: ./python -m doctest Doc/library/inspect.html ---------- nosy: +asvetlov _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Andrew Svetlov added the comment: Update patch ---------- Added file: http://bugs.python.org/file26737/inspect.pep362.4.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Yury Selivanov added the comment: Thanks a lot for the patch update, Andrew! Please let me glance over it once again today/tomorrow before you commit it. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Andrew Svetlov added the comment: Slightly updated version ---------- Added file: http://bugs.python.org/file26768/inspect.pep362.5.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Roundup Robot added the comment: New changeset 814462492fbd by Andrew Svetlov in branch 'default': Issue #15151: PEP 362 — document signature and related classes for inspect.py http://hg.python.org/cpython/rev/814462492fbd ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Andrew Svetlov added the comment: Closing the issue. Feel free to reopen if you have some corrections. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Changes by Andrew Svetlov <andrew.svetlov@gmail.com>: ---------- resolution: -> fixed stage: -> committed/rejected status: open -> closed type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Yury Selivanov added the comment: Thank you, Andrew. One thing: can you please change:
Print all keyword-only arguments without default values:
to
Example: print all keyword-only arguments without default values:
? ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
Andrew Svetlov added the comment: Done in 843e0da7e91f ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15151> _______________________________________
participants (7)
-
Andrew Svetlov -
Brett Cannon
-
Georg Brandl
-
Larry Hastings
-
Nick Coghlan
-
Roundup Robot
-
Yury Selivanov