[issue17661] documentation of '%r' links to the wrong repr
Kyle Roberts
report at bugs.python.org
Wed Apr 10 05:21:34 CEST 2013
Kyle Roberts added the comment:
Adding a '.' to the beginning (i.e. `.repr`) creates a link to repr.html#repr.repr. This made more sense after perusing Sphinx's documentation:
"If you prefix the name with a dot, this order is reversed. For example, in the documentation of Python’s codecs module, :py:func:`open` always refers to the built-in function, while :py:func:`.open` refers to codecs.open()."
I'm not sure what other options I can try after looking at the reST documentation. It seems like our best bet would be if we could define a priority for same-name functions when two definitions are discovered. I didn't see a way to do this in Sphinx/reST so I'm not sure how to move forward with this. I'm assuming we don't want to link directly to the correct url if it can be avoided.
Also, I noticed http://docs.python.org/2/library/repr.html#module-repr links to the wrong repr() a few times where it mentions the "built-in" function.
----------
nosy: +kyle.roberts
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue17661>
_______________________________________
More information about the Python-bugs-list
mailing list