#12810: Broken links in the documentation of graph/ files
---------------------------------+------------------------------------------
Reporter: ncohen | Owner: jason, ncohen, rlm
Type: defect | Status: needs_work
Priority: major | Milestone: sage-5.1
Component: graph theory | Resolution:
Keywords: sd40.5 | Work issues:
Report Upstream: N/A | Reviewers: Karl-Dieter Crisman
Authors: Nathann Cohen | Merged in:
Dependencies: | Stopgaps:
---------------------------------+------------------------------------------
Changes (by kcrisman):
* keywords: => sd40.5
* reviewer: => Karl-Dieter Crisman
* status: needs_review => needs_work
Comment:
There remain
{{{
/Users/.../sage-5.1.beta1/local/lib/python2.7/site-
packages/sage/graphs/graph_latex.py:docstring of
sage.graphs.graph_latex.GraphLatex.get_option:9: WARNING: py:data
reference target not found: __graphlatex_options
/Users/.../sage-5.1.beta1/local/lib/python2.7/site-
packages/sage/graphs/graph_latex.py:docstring of
sage.graphs.graph_latex.GraphLatex.latex:3: WARNING: py:meth reference
target not found: sage.graphs.generic_graph.GenericGraph._latex_
/Users/.../sage-5.1.beta1/local/lib/python2.7/site-
packages/sage/graphs/graph_latex.py:docstring of
sage.graphs.graph_latex.GraphLatex.set_option:11: WARNING: py:data
reference target not found:
sage.graphs.graph_latex.GraphLatex.__graphlatex_options
}}}
Couldn't one just change the syntax to say
{{{
``sage.graphs.graph_latex.GraphLatex.__graphlatex_options``
}}}
instead of the following?
{{{
:data:`sage.graphs.graph_latex.GraphLatex.__graphlatex_options`
}}}
Something similar might be able to be said about
{{{
:meth:`sage.graphs.generic_graph.GenericGraph._latex_`
}}}
but then again maybe this is not worth the trouble. I still wish we had
the "superreference" target for the docbuild, which included all
underscore methods.
Also, we are trying to discourage double-underscore attributes. Such as
`__graphlatex_options`. Could this be made single-underscore (perhaps in
another ticket, if appropriate)?
More comments:
* The doc looks wrong in the (short) tree.pyx - you'll see what I mean.
* The AUTHORS in matchpoly is indented too much.
* graph_plot.html can have trac #10124 written as {{{:trac:`#10124`}}}, I
think.
All that said, it seems like it's pretty good overall.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12810#comment:6>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
