#19390: Update the documentation of Graph/DiGraph constructors
-------------------------+-------------------------------------------------
Reporter: | Owner:
ncohen | Status: needs_review
Type: | Milestone: sage-6.10
enhancement | Resolution:
Priority: major | Merged in:
Component: graph | Reviewers:
theory | Work issues:
Keywords: | Commit:
Authors: | 4bc51d480bf228cf1bfbcaf25dc2737374a9c7e0
Nathann Cohen | Stopgaps:
Report Upstream: N/A |
Branch: |
u/ncohen/19390 |
Dependencies: |
#19385 |
-------------------------+-------------------------------------------------
Comment (by ncohen):
Helloooooo,
> in digraph.py
> - {{{<http://en.wikipedia.org/wiki/Digraph_%28mathematics%29>`_.For a
collection}}} one space missing
Done.
> - {{{``DiGraph({1: {2: 'a', 3:'b'} ,3:{2:'c'}})`` -- return a graph
by}}} a digraph. Same in several places
Sorry... Done.
> - {{{DiGraph(a_nonsquare_matrix)}}} an incidence matrix ?
I did not change that, but I will change it if you want me to: let me just
tell you why I wrote it this way. I chose to say "nonsquare_matrix" to
hint that this is how a matrix is "automatically detected" to be an
incidence matrix, and that to make sure one should use the explicit
'format' flag. That's why. If you think that it is still better the other
way, tell me and I will update.
> - {{{edge `u,f` whenever ``f(u,v)`` is ``True``}}} -> edge `u,v`
Done.
> - {{{``DiGraph(another_digraph)`` -- return a graph from a Sage
graph,}}} from a Sage graph or digraph ?
Done.
> in graph.py
> - {{{edge `u,f` whenever ``f(u,v)`` is ``True``}}} -> edge `u,v`
Done.
> - {{{``Graph(another_graph)`` -- return a graph from a Sage graph,}}}
from a Sage graph or digraph ?
Done.
> - {{{only the integers 0, ..., n-1, where n is the number of
vertices.}}} math mode around 0, ..., n-1 and n ?
Done, though I will do something about this parameter because it does not
make any sense. It was apparently added during the igraph tickets, but its
name (`vertex_labels`) does not hint *at all* at igraph. The doc does not
either. People could wonder about its effect with every other possible
combinations of inputs, and it only appears in the code because of igraph.
So I think we should remove it quick and deal with the igraph case
otherwise.
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/19390#comment:4>
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.
