#8458: iterator for graphs() doesn't return independent graphs
----------------------------+-----------------------------------------------
Reporter: mvngu | Owner: rlm
Type: defect | Status: needs_info
Priority: major | Milestone: sage-5.0
Component: graph theory | Keywords:
Work_issues: | Upstream: N/A
Reviewer: | Author:
Merged: | Dependencies:
----------------------------+-----------------------------------------------
Changes (by ncohen):
* status: needs_review => needs_info
Comment:
Helloooooo !!!
This is a good patch, but I do not think the documentation is very clear.
What would you think of changing the new argument's name to
"return_copies" or "graph_copy" ? To be honest I took me 2 minutes to
understand that this message's title did not mean "The independent graph
is not returned by graphs(n)" `:-p`
Either way, with a name like "independent" it is not very clear that there
may be performances issues hidden in this argument.
Here's what I would write. Of course, it's just my advice, so take or
leave whatever you want :
{{{
- ``copy_graphs`` (boolean) -- If set to ``True`` (default) this method
makes copies of the graphs before returning them. If set to ``False`` the
method returns the graph it is working on. The second alternative is
faster, but modifying any of the graph instances returned by the method
may break the function's behaviour, as it is using these graphs to compute
the next ones : only use ``copy_graph = False`` when you stick to
*reading* the graphs returned.
}}}
Please tell me what you think `:-)`
Nathann
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8458#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 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.
