[docs] Use long dash (issue 18529)

ezio.melotti at gmail.com ezio.melotti at gmail.com
Thu Jul 25 06:58:46 CEST 2013


http://bugs.python.org/review/18529/diff/8715/Doc/faq/extending.rst
File Doc/faq/extending.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/faq/extending.rst#newcode319
Doc/faq/extending.rst:319: more input is required --- by extracting the
message string from the exception
This doesn't seem right to me, I think it should just be removed.

http://bugs.python.org/review/18529/diff/8715/Doc/howto/urllib2.rst
File Doc/howto/urllib2.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/howto/urllib2.rst#newcode33
Doc/howto/urllib2.rst:33: handling common situations --- like basic
authentication, cookies, proxies and so
This could be dropped as well.

http://bugs.python.org/review/18529/diff/8715/Doc/library/argparse.rst
File Doc/library/argparse.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/library/argparse.rst#newcode688
Doc/library/argparse.rst:688: * ``'store'`` --- This just stores the
argument's value.  This is the default
The single '-' seems to be used somewhat often to separate a list
element from its description.  I'm not sure if there's any convention
about this and if it's acceptable.  If it is it should be kept,
otherwise both a '---' or a ':' should work.

http://bugs.python.org/review/18529/diff/8715/Doc/library/codecs.rst
File Doc/library/codecs.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/library/codecs.rst#newcode759
Doc/library/codecs.rst:759: The :class:`StreamRecoder` provide a
frontend --- backend view of encoding data
This is wrong.

http://bugs.python.org/review/18529/diff/8715/Doc/library/decimal.rst
File Doc/library/decimal.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/library/decimal.rst#newcode73
Doc/library/decimal.rst:73: and rounded floating-point arithmetic."  ---
excerpt from the decimal
You could remove the double space while you are at it.

http://bugs.python.org/review/18529/diff/8715/Doc/library/logging.handlers.rst
File Doc/library/logging.handlers.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/library/logging.handlers.rst#newcode533
Doc/library/logging.handlers.rst:533: versions of these daemons expected
a NUL terminated message --- even
You could add an hyphen between NUL and terminated too.

http://bugs.python.org/review/18529/diff/8715/Doc/library/unittest.mock.rst
File Doc/library/unittest.mock.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/library/unittest.mock.rst#newcode2235
Doc/library/unittest.mock.rst:2235: just be ordinary mocks (well ---
`MagicMocks`):
Maybe here a comma is better?

http://bugs.python.org/review/18529/diff/8715/Doc/tutorial/whatnow.rst
File Doc/tutorial/whatnow.rst (right):

http://bugs.python.org/review/18529/diff/8715/Doc/tutorial/whatnow.rst#newcode69
Doc/tutorial/whatnow.rst:69: reported by www.egroups.com; Jan. 2000 ---
June 2000: 21272 msgs / 182
I think an en dash would be more appropriate here.

http://bugs.python.org/review/18529/


More information about the docs mailing list