Documentation for Signature, Parameter and signature in inspect module

[ncoghlan]

BPO	15151
Nosy	@brettcannon, @birkenfeld, @ncoghlan, @larryhastings, @asvetlov, @1st1
Files	inspect.pep362.1.patch inspect.pep362.2.patch inspect.pep362.3.patch inspect.pep362.4.patch inspect.pep362.5.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2012-08-13.14:14:54.738>
created_at = <Date 2012-06-23.06:13:49.861>
labels = ['deferred-blocker', 'type-feature', 'docs']
title = 'Documentation for Signature, Parameter and signature in inspect module'
updated_at = <Date 2012-08-13.15:24:56.626>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2012-08-13.15:24:56.626>
actor = 'asvetlov'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-08-13.14:14:54.738>
closer = 'asvetlov'
components = ['Documentation']
creation = <Date 2012-06-23.06:13:49.861>
creator = 'ncoghlan'
dependencies = []
files = ['26410', '26419', '26420', '26737', '26768']
hgrepos = []
issue_num = 15151
keywords = ['patch']
message_count = 15.0
messages = ['163534', '164098', '165560', '165681', '165727', '165728', '166033', '167705', '167778', '167781', '168001', '168109', '168110', '168113', '168117']
nosy_count = 8.0
nosy_names = ['brett.cannon', 'georg.brandl', 'ncoghlan', 'larry', 'asvetlov', 'docs@python', 'python-dev', 'yselivanov']
pr_nums = []
priority = 'deferred blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue15151'
versions = ['Python 3.3']

[ncoghlan]

The PEP-362 implementation has been committed, but the inspect module documentation still needs to be updated.

[birkenfeld]

Moving back to blocker for beta2.

[larryhastings]

Is anyone working on this? I could possibly take a stab at it tonight, if I get the evening to myself.

[1st1]

Larry, Brett,

I compiled the documentation from the PEP (attached as inspect.PEP-362.1.patch). Please take a look and feel free to add/edit.

[1st1]

The new patch version (inspect.PEP-362.2.patch) includes more examples and includes recommendations to use the Signature Object instead of 'inspect.getfullargsspec'. Please review.

[1st1]

New patch version - inspect.PEP-362.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.

[birkenfeld]

Docs issues won't block b2.

[asvetlov]

Yury, please updete your patch to pass doctest:

./python -m doctest Doc/library/inspect.html

[asvetlov]

Update patch

[1st1]

Thanks a lot for the patch update, Andrew! Please let me glance over it once again today/tomorrow before you commit it.

[asvetlov]

Slightly updated version

[python-dev]

New changeset 814462492fbd by Andrew Svetlov in branch 'default':
Issue bpo-15151: PEP-362 — document signature and related classes for inspect.py
http://hg.python.org/cpython/rev/814462492fbd

[asvetlov]

Closing the issue. Feel free to reopen if you have some corrections.

[1st1]

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:

?

[asvetlov]

Done in 843e0da7e91f