#12626: Kautz, Imase and Itoh, and Generalized de Bruijn digraph generators
----------------------------+-----------------------------------------------
Reporter: dcoudert | Owner: jason, ncohen, rlm
Type: enhancement | Status: needs_work
Priority: minor | Milestone: sage-5.0
Component: graph theory | Keywords:
Work_issues: | Upstream: N/A
Reviewer: | Author: David Coudert
Merged: | Dependencies:
----------------------------+-----------------------------------------------
Changes (by ncohen):
* status: needs_review => needs_work
Comment:
Helloooooo David !!!
Looks like there is something wrong with your doctests ! You forgot to add
many "::" and so the doctests you add do not appear in the documentation
(and probably are not tested when you run "sage -t")
Some other things : we try to keep the "first line" of the documentation
of each function "short and descriptive". Something like "its meaning in
at most one line". Something like what you find in "RandomDirectedGNR" or
in "DeBruijn". When it requires some details, they are given immediately
after, though.
In the documentation you define the "degree d", but "degree" appears in
the formulas, like in "v \equiv -u*degree-a-1 \mod{n}"
I noticed that you added a link toward a Wikipedia page... Did you see
this ":wikipedia:" somewhere already ? During the last Sage Combinat days
Florent Hivert actually added such a thing in Sage ! It is patch #12490.
As written, this link does not display correctly in the doc, but since
#12490 has been merged you can replace
{{{
See also :wikipedia: http://en.wikipedia.org/wiki/Kautz_graph
}}}
by
{{{
See also the :wikipedia:`Wikipedia article on Kautz Graphs <Kautz_graph>`
}}}
Note that the argument is not a full link, but only the article's name
`:-)`
Nathann
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12626#comment:3>
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.
