Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(1988)

#15151: Documentation for Signature, Parameter and signature in inspect module

Can't Edit
Can't Publish+Mail
Start Review
Created:
11 months, 1 week ago by ncoghlan
Modified:
10 months, 1 week ago
Reviewers:
andrew.svetlov, yselivanov.ml
CC:
brett.cannon, Georg, Nick Coghlan, larry, asvetlov, docs_python.org, devnull_psf.upfronthosting.co.za, yselivanov
Visibility:
Public.

Patch Set 1 #

Patch Set 2 #

Patch Set 3 #

Total comments: 8

Patch Set 4 #

Patch Set 5 #

Unified diffs Side-by-side diffs Delta from patch set Stats Patch
Doc/library/inspect.rst View 1 2 3 4 3 chunks +268 lines, -0 lines 0 comments Download

Messages

Total messages: 2
asvetlov
docs review http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst File Doc/library/inspect.rst (right): http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst#newcode432 Doc/library/inspect.rst:432: provide no metadata about their arguments. maybe ...
10 months, 2 weeks ago #1
yselivanov
10 months, 2 weeks ago #2
http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst
File Doc/library/inspect.rst (right):

http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst#newcode432
Doc/library/inspect.rst:432: provide no metadata about their arguments.
On 2012/08/08 21:14:48, asvetlov wrote:
> maybe "metadata for their arguments"?

"about" is better.

http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst#newcode442
Doc/library/inspect.rst:442: a modified copy
On 2012/08/08 21:14:48, asvetlov wrote:
> put dot at end

agree

http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst#newcode547
Doc/library/inspect.rst:547: **Example**
On 2012/08/08 21:14:48, asvetlov wrote:
> Just remove this line. Bold looks ugly from my perspective

well, there needs to be some kind of header.

http://bugs.python.org/review/15151/diff/5438/Doc/library/inspect.rst#newcode607
Doc/library/inspect.rst:607: >>> def foo(a, b=10):
On 2012/08/08 21:14:48, asvetlov wrote:
> Deindent example to avoid gray border around. Not sure.

I actually like how grey borders separate examples from other content.  Makes it
easier to read
Sign in to reply to this message.

RSS Feeds Recent Issues | This issue
This is Rietveld cbc36f91f3f7