[issue17661] documentation of '%r' links to the wrong repr

[Roundup Robot]

Roundup Robot added the comment:

New changeset dd5e7aef4d5b by Georg Brandl in branch '2.7':
Closes #17661: fix references to repr() going to module repr.
http://hg.python.org/cpython/rev/dd5e7aef4d5b

--
nosy: +python-dev
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Georg Brandl]

Georg Brandl added the comment:

Fixed, thanks.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Dan Riti]

Dan Riti added the comment:

Reproduced the issue and generated a patch following Kyle's documented 
approach. 

Please note that this patch addresses the link problem, but does not address 
the style issue. Thanks.

--
keywords: +patch
nosy: +Dan.Riti
Added file: http://bugs.python.org/file29801/using-ref.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Ezio Melotti]

Ezio Melotti added the comment:

I don't think the style is so important, especially since this issue only 
affects 2.7.

--
stage:  -> needs patch
type:  -> enhancement

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Kyle Roberts]

Changes by Kyle Roberts :


Added file: http://bugs.python.org/file29772/diff_style_markup.PNG

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Kyle Roberts]

Kyle Roberts added the comment:

So the :ref: keyword helps and creates a link, but it has the unfortunate side 
effect of adding different markup and style. I've attached two images to 
illustrate the differences. I couldn't find a way in the Sphinx or reST 
documentation to force it to style like a :func:, and my searches didn't come 
up with much either. Does anyone know of a way to style a :ref: just like a 
:func:?

The code I used to create the fixed link is:

:ref:`repr() `

--
Added file: http://bugs.python.org/file29771/diff_style_example.PNG

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Kyle Roberts]

Kyle Roberts added the comment:

Ah that's the type of thing I was looking for, thanks Éric. I saw the 
underscored reference in functions.rst last night but figured it was just a 
local file link. I'll have a patch available later today. Thanks again.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Éric Araujo]

Éric Araujo added the comment:

You can always use a ref role instead of func.  func tries to find a module, 
class or function in the global Sphinx index, but ref lets you link to one 
specific target (see the table at the top of library/functions.rst for an 
example).

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Antoine Pitrou]

Antoine Pitrou added the comment:

> It just highlights the mistake we made calling a builtin module the
> same name as a builtin function :)

But shouldn't the highlighting be handled by Pygments? 
;)

--
nosy: +pitrou

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Kyle Roberts]

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Georg Brandl]

Georg Brandl added the comment:

It just highlights the mistake we made calling a builtin module the same name 
as a builtin function :)

--
nosy: +georg.brandl

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Éric Araujo]

Éric Araujo added the comment:

Thanks for catching this; Sphinx’ lookup is confusing sometimes.  Using `.repr` 
or something similar will fix it.

--
nosy: +eric.araujo, ezio.melotti

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue17661] documentation of '%r' links to the wrong repr

[Thomas Wouters]

New submission from Thomas Wouters:

The documentation of '%r' in 
http://docs.python.org/2/library/stdtypes.html#string-formatting-operations 
links to the wrong repr, the module 
(http://docs.python.org/2/library/repr.html#module-repr) instead of the builtin 
function (http://docs.python.org/2/library/functions.html#func-repr).

--
assignee: docs@python
components: Documentation
keywords: easy
messages: 186292
nosy: docs@python, twouters
priority: normal
severity: normal
status: open
title: documentation of '%r' links to the wrong repr
versions: Python 2.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com