[docs] Patch to enhance literal block language declaration (issue 26462)

vadmium+py at gmail.com vadmium+py at gmail.com
Tue Jul 26 02:32:56 EDT 2016


https://bugs.python.org/review/26462/diff/17976/Doc/extending/newtypes.rst
File Doc/extending/newtypes.rst (right):

https://bugs.python.org/review/26462/diff/17976/Doc/extending/newtypes.rst#newcode212
Doc/extending/newtypes.rst:212: in a file called :file:`setup.py`; then
typing:
Not a big deal, but I don’t think this colon is needed

https://bugs.python.org/review/26462/diff/17976/Doc/library/2to3.rst
File Doc/library/2to3.rst (right):

https://bugs.python.org/review/26462/diff/17976/Doc/library/2to3.rst#newcode63
Doc/library/2to3.rst:63: can be given with :option:`-f`.  Likewise the
:option:`-x` explicitly disables a
I presume this line was changed accidentally. The :option:`-x` link is
wrong; see <https://bugs.python.org/issue26638> where I made this
change.

https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst
File Doc/library/decimal.rst (right):

https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#newcode168
Doc/library/decimal.rst:168: .. doctest::
$ make -C Doc/ doctest
. . .
WARNING: no code/output in doctest block at
/media/disk/home/proj/python/cpython/Doc/library/decimal.rst:168

Also, with or without this change, I get no highlighting. Perhaps there
should be a blank line inbetween?

https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#newcode173
Doc/library/decimal.rst:173: File "<stdin>", line 1, in <module>
Or perhaps because of missing indentation here?

https://bugs.python.org/review/26462/diff/17976/Doc/library/decimal.rst#newcode247
Doc/library/decimal.rst:247: .. doctest::
WARNING: no code/output in doctest block at
/media/disk/home/proj/python/cpython/Doc/library/decimal.rst:247

https://bugs.python.org/review/26462/diff/17976/Doc/library/logging.config.rst
File Doc/library/logging.config.rst (right):

https://bugs.python.org/review/26462/diff/17976/Doc/library/logging.config.rst#newcode635
Doc/library/logging.config.rst:635: Examples of these sections in the
file are given below. :
This produces a floating colon (:) at the end of the line. Perhaps
remove it completely? (same problem below)

https://bugs.python.org/review/26462/diff/17976/Doc/library/pyexpat.rst
File Doc/library/pyexpat.rst (right):

https://bugs.python.org/review/26462/diff/17976/Doc/library/pyexpat.rst#newcode874
Doc/library/pyexpat.rst:874: not. See
http://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl
This is reverting an unrelated change (Issue 26736). I suggest not to
mess with newlines in files you edit without a good reason.

https://bugs.python.org/review/26462/diff/17976/Doc/library/subprocess.rst
File Doc/library/subprocess.rst (left):

https://bugs.python.org/review/26462/diff/17976/Doc/library/subprocess.rst#oldcode960
Doc/library/subprocess.rst:960: # becomes
These are all hybrid python3 and Unix shell code. I guess “python” means
Python 2, where `...` means repr(...).

I guess we could split here into two blocks (Unix shell and python3)

https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.3.rst
File Doc/whatsnew/3.3.rst (left):

https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.3.rst#oldcode1002
Doc/whatsnew/3.3.rst:1002: $ ./python -q
I think you can just drop the python -q line instead

https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.5.rst
File Doc/whatsnew/3.5.rst (right):

https://bugs.python.org/review/26462/diff/17976/Doc/whatsnew/3.5.rst#newcode294
Doc/whatsnew/3.5.rst:294: .. code-block:: pycon
$ make -C Doc/ suspicious PYTHON=python3
. . .
WARNING: [whatsnew/3.5:294] "::" found in ".. code-block:: pycon"

Maybe the double colon (::) needs adjusting?

In fact, why is this change needed at all? Maybe it is just that my
Sphinx or whatever needs updating to understand the new operator.

https://bugs.python.org/review/26462/


More information about the docs mailing list