#19390: Update the documentation of Graph/DiGraph constructors
----------------------------+---------------------------------
Reporter: ncohen | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.10
Component: graph theory | Keywords:
Merged in: | Authors: Nathann Cohen
Reviewers: | Report Upstream: N/A
Work issues: | Branch:
Commit: | Dependencies: #19385
Stopgaps: |
----------------------------+---------------------------------
All this documentation was pretty outdated, and some formats were missing.
I also tried to make it easier to read/parse, by displaying at the
beginning of the INPUT blocks the different formats (and not just by
giving their names).
In particular, I do not think that it is very important to burden the
users with a 'format' flag in most cases, when there is no ambiguity.
However, when the input is a matrix and the behaviour depends on its
properties, it is advertised.
A lot of documentation is also removed: some of it is replaced by links
toward dedicated modules (i.e. 'how to access the graph catalog') or
simply removed: the `__init__` entry in th reference manual is no place to
explain how to compute connected components.
There is still a lot of verbosity in this module, and in particular all
the file formats *also* appear in the module's documentation (and are, of
course, outdated). This will be for later.
One of the points of this branch is also to ease maintainability: when the
same things are documented in different places at once, we forget to
update all of it when it would be needed. Short, and to the point: that's
a reference manual, not a tutorial.
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/19390>
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 http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
