[docs] Standardize documentation whitespace, formatting (issue 23921)
vadmium+py at gmail.com
vadmium+py at gmail.com
Wed Jan 6 20:41:26 EST 2016
http://bugs.python.org/review/23921/diff/14579/Doc/faq/library.rst
File Doc/faq/library.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/faq/library.rst#newcode747
Doc/faq/library.rst:747:
Could probably drop this new blank line
http://bugs.python.org/review/23921/diff/14579/Doc/faq/programming.rst
File Doc/faq/programming.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/faq/programming.rst#newcode668
Doc/faq/programming.rst:668: >>> print(b)
Why not add prompts to the lines above as well?
http://bugs.python.org/review/23921/diff/14579/Doc/library/abc.rst
File Doc/library/abc.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/library/abc.rst#newcode92
Doc/library/abc.rst:92:
FWIW I think the existing compact form is fine. The methods don’t have
any substance, so separating them doesn’t buy much. But if you want to
make the style consistent with MyIterable, you need a blank line above
__getitem__() as well.
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst
File Doc/whatsnew/3.2.rst (left):
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#oldcode502
Doc/whatsnew/3.2.rst:502:
You could keep the blank line here to mirror the interactive interpreter
better
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst
File Doc/whatsnew/3.2.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#newcode1107
Doc/whatsnew/3.2.rst:1107: ... b'G3805 storeroom Main chassis '
Why not a four-space indent?
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#newcode1555
Doc/whatsnew/3.2.rst:1555: ... name = 'xz',
I think you could drop the space around the equal signs and make it
name='xz', etc.
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#newcode1882
Doc/whatsnew/3.2.rst:1882:
Add an extra ellipsis to imitate the interpreter better
http://bugs.python.org/review/23921/
More information about the docs
mailing list