[docs] interning and list comprehension leads to unexpected behavior (issue 23406)

vadmium+py at gmail.com vadmium+py at gmail.com
Wed Sep 2 23:40:56 CEST 2015


https://bugs.python.org/review/23406/diff/15454/Doc/library/stdtypes.rst
File Doc/library/stdtypes.rst (right):

https://bugs.python.org/review/23406/diff/15454/Doc/library/stdtypes.rst#newcode900
Doc/library/stdtypes.rst:900: sequence of the same type as *s*).  Note
also that the copies are shallow;
Objects are not even shallow-copied in the usual sense. Perhaps
something like this is better:

(. . . same type as *s*). The *s* object is not copied; it is merely
referenced multiple times. This often haunts . . .

https://bugs.python.org/review/23406/diff/15454/Doc/library/stdtypes.rst#newcode924
Doc/library/stdtypes.rst:924: `FAQ
<https://docs.python.org/3/faq/programming.html#how-do-i-create-a-multidimensional-list>`_.
It will be better to do an internal link within the same copy of the
documentation. See
<https://docs.python.org/devguide/documenting.html#doc-ref-role>. In
particular, add something like this before the heading in
/Doc/faq/programming.rst:

.. _faq-multidimensional-list:

And then change the code here to

Further explanation is available in the FAQ entry
:ref:`faq-multidimensional-list`.

which should expand to the full heading title.

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


More information about the docs mailing list