#20639: Sphinx sometimes doesn't resolve :meth:`.method` references correctly
-------------------------------------------------+-------------------------
Reporter: embray | Owner:
Type: defect | Status: new
Priority: minor | Milestone: sage-7.3
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: | Reviewers:
Report Upstream: Not yet reported upstream; | Work issues:
Will do shortly. | Commit:
Branch: | Stopgaps:
Dependencies: |
-------------------------------------------------+-------------------------
Comment (by embray):
The Sphinx docs read:
> Normally, names in these roles are searched first without any further
qualification, then with the current module name prepended, then with the
current module and class name (if any) prepended. 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()`.
Later it reads:
> Also, if the name is prefixed with a dot, and no exact match is found,
the target is taken as a suffix and all object names with that suffix are
searched. For example, {{{:py:meth:`.TarFile.close`}}} references the
{{{tarfile.TarFile.close()}}} function, even if the current module is not
tarfile. Since this can get ambiguous, if there is more than one possible
match, you will get a warning from Sphinx.
So that does more or less reflect the current behavior accurately.
However, for attributes and methods of classes, the matching should take
into consideration the class's subclasses, and currently it does not. So
it complains about ambiguity when really there's nothing ambiguous.
--
Ticket URL: <http://trac.sagemath.org/ticket/20639#comment:5>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
