small issue in the "Documenting Python" guide
Dear Python Documenters, reading the fine guide on Documenting Python, I found a small misstake in the description of reST roles at the end of the section `Inline Markup`_ The "pep" and "rfc" roles are not "additional markup constructs" but part of the standard reST syntax. https://docutils.sourceforge.io/docs/ref/rst/roles.html#pep-reference The last sentence of section `Inline Markup`_ could be enhanced by a link to the upstream documentation:: Note that there are no special roles for including hyperlinks as you can use the `standard reST markup for that purpose`__. __ https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup .. _Inline Markup: https://devguide.python.org/documenting/#rest-inline-markup Sincerely, Günter Milde
participants (1)
-
Guenter Milde