[docs] Improve cross-references in C API (issue 19195)
georg at python.org
georg at python.org
Wed Oct 9 09:54:56 CEST 2013
http://bugs.python.org/review/19195/diff/9475/Doc/c-api/buffer.rst
File Doc/c-api/buffer.rst (right):
http://bugs.python.org/review/19195/diff/9475/Doc/c-api/buffer.rst#newcode47
Doc/c-api/buffer.rst:47: the buffer interface can be written to a file.
While :meth:`~io.BufferedIOBase.write` only
Left as-is is fine as well.
Special decorations aren't really required; we shouldn't add semantic
markup for purity's sake, only when it's useful for linking.
On 2013/10/09 08:43:25, storchaka wrote:
> On 2013/10/08 22:22:46, Georg wrote:
> > just replace by ``write()``, two references in two sentences is not
needed
>
> Perhaps :meth:`!write`? Or left as is? I suppose documentation
formatter can use
> special style decorations for different roles.
http://bugs.python.org/review/19195/diff/9475/Doc/c-api/typeobj.rst
File Doc/c-api/typeobj.rst (right):
http://bugs.python.org/review/19195/diff/9475/Doc/c-api/typeobj.rst#newcode643
Doc/c-api/typeobj.rst:643: When a type's :attr:`~object.__slots__`
declaration contains a slot named
Yes, of course. This markup was there before, I only looked at your
changes.
On 2013/10/09 08:43:25, storchaka wrote:
> On 2013/10/08 22:22:46, Georg wrote:
> > here too: too many links are not needed and distract.
>
> Doesn't many :c:member:`~PyTypeObject.tp_weaklistoffset` distract?
http://bugs.python.org/review/19195/
More information about the docs
mailing list