#15719: Fix documentation bugs
-------------------------------------+-------------------------------------
Reporter: vbraun | Owner:
Type: defect | Status: new
Priority: blocker | Milestone: sage-6.1
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Marc Mezzarobba, | Reviewers:
Martin Raum | Work issues:
Report Upstream: N/A | Commit:
Branch: | 88deaea2bdcc94c306ac888bb1c58479726fe1d3
public/15719-doc_bugs | Stopgaps:
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by SimonKing):
Replying to [comment:14 ncohen]:
> > Nathan, are you working on the graph theory doc issues?
>
> Well, my comment above is a question to Simon, soooo....
Your comment is a reply to my question to you, sooooo, I hope it is OK
that my reply to your counter-question is a bunch of counter-counter-
questions.
Mainly I want to know what you (as the author) have to say about the
purpose of this method.
Is this method supposed to be called by people? Or is it an auxiliary
method that should only be called internally, i.e., called from other
methods that only work for simple graphs? The name suggests to me that the
latter is the case, but I think you know better than I what the purpose of
this method is.
I think a method that is supposed to be called by people should be named
".is_simple()", and it shouldn't scream but return True resp. False. Of
course, regardless of its name, the method must have a docstring and
tests.
Can you argue why this method is more than just an internally used method?
If it is more than that, then I wouldn't mind at all to keep it in the
docs. Otherwise, I would mind a little bit, but not much.
--
Ticket URL: <http://trac.sagemath.org/ticket/15719#comment:15>
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/groups/opt_out.
