[docs] Standardize documentation whitespace, formatting (issue 23921)
storchaka at gmail.com
storchaka at gmail.com
Tue May 10 04:37:40 EDT 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:
On 2016/01/07 02:41:26, vadmium wrote:
> Could probably drop this new blank line
Done.
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)
On 2016/03/02 08:04:04, Georg wrote:
> On 2016/01/07 02:41:26, vadmium wrote:
> > Why not add prompts to the lines above as well?
>
> Yes, link this it's a bit inconsistent.
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/howto/logging-cookbook.rst
File Doc/howto/logging-cookbook.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/howto/logging-cookbook.rst#newcode742
Doc/howto/logging-cookbook.rst:742: root.setLevel(logging.DEBUG) # send
all messages, for demo; no other level or filter logic applied.
On 2016/03/02 08:04:04, Georg wrote:
> this is probably too long a line (e.g. for PDF output), better move
the comment
> above the code
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/howto/urllib2.rst
File Doc/howto/urllib2.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/howto/urllib2.rst#newcode178
Doc/howto/urllib2.rst:178: values = {'name' : 'Michael Foord',
On 2016/03/02 08:04:04, Georg wrote:
> could also remove the spaces before ':' as well.
Done.
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:
On 2016/01/07 02:41:26, vadmium wrote:
> 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.
Done. Removed empty lines.
http://bugs.python.org/review/23921/diff/14579/Doc/library/locale.rst
File Doc/library/locale.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/library/locale.rst#newcode473
Doc/library/locale.rst:473: >>> locale.strcoll('f\xe4n', 'foo') #
compare a string containing an umlaut
On 2016/03/02 08:04:04, Georg wrote:
> keep only 2 spaces, the line is already long
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/library/multiprocessing.rst
File Doc/library/multiprocessing.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/library/multiprocessing.rst#newcode2071
Doc/library/multiprocessing.rst:2071: print(result.get(timeout=1))
# prints "100" unless your computer is *very* slow
On 2016/03/02 08:04:04, Georg wrote:
> these lines are also too long.
Will be addressed in separate issue. Changes for this example are
reverted.
http://bugs.python.org/review/23921/diff/14579/Doc/library/optparse.rst
File Doc/library/optparse.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/library/optparse.rst#newcode1827
Doc/library/optparse.rst:1827: [...]
On 2016/03/02 08:04:04, Georg wrote:
> replace by a single ellipsis, I don't think we're using that style
anywhere else
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/library/tokenize.rst
File Doc/library/tokenize.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/library/tokenize.rst#newcode216
Doc/library/tokenize.rst:216: if toknum == NUMBER and '.' in tokval:
# replace NUMBER tokens
On 2016/03/02 08:04:04, Georg wrote:
> no, keep shorter line
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/library/urllib.request.rst
File Doc/library/urllib.request.rst (right):
http://bugs.python.org/review/23921/diff/14579/Doc/library/urllib.request.rst#newcode1105
Doc/library/urllib.request.rst:1105: ...
data=b'This data is passed to stdin of the CGI')
On 2016/03/02 08:04:04, Georg wrote:
> this is also a case where the longer line may hurt
Done.
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:
On 2016/01/07 02:41:26, vadmium wrote:
> You could keep the blank line here to mirror the interactive
interpreter better
Done.
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 '
On 2016/01/07 02:41:26, vadmium wrote:
> Why not a four-space indent?
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#newcode1540
Doc/whatsnew/3.2.rst:1540: >>> os.chdir('mydata')
# change to the source directory
On 2016/03/02 08:04:04, Georg wrote:
> again, too long lines here.
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#newcode1555
Doc/whatsnew/3.2.rst:1555: ... name = 'xz',
On 2016/01/07 02:41:26, vadmium wrote:
> I think you could drop the space around the equal signs and make it
name='xz',
> etc.
Done.
http://bugs.python.org/review/23921/diff/14579/Doc/whatsnew/3.2.rst#newcode1882
Doc/whatsnew/3.2.rst:1882:
On 2016/01/07 02:41:26, vadmium wrote:
> Add an extra ellipsis to imitate the interpreter better
Done.
http://bugs.python.org/review/23921/
More information about the docs
mailing list