#7477: Matroids
----------------------------------------------------+-----------------------
Reporter: ncohen | Owner: jkantor
Type: enhancement | Status:
needs_review
Priority: major | Milestone: sage-5.10
Component: combinatorics | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Stefan van Zwam, Rudi Pendavingh | Merged in:
Dependencies: #14669 | Stopgaps:
----------------------------------------------------+-----------------------
Comment (by tscrim):
My 2 cents on `OUTPUT:` and `INPUT:` blocks. iI there is no input other
than ``self``, there is no need for an `INPUT:` IMO since with ``self``,
the input is clear. For output blocks, if the short description of the
method (i.e. the first line) tells the object that it returns, I don't see
the need to write an `OUTPUT:` block. Additionally if the object needs
description (mathematically), then I think that should go in the second
paragraph of the documentation. For example:
{{{
def loops(self):
"""
Return the loops of ``self``.
A *loop* is a one-element dependent subset.
EXAMPLES::
...
def is_cosimple(self):
"""
Return ``True`` if ``self`` is cosimple.
A matriod is *cosimple* if ...
EXAMPLES::
...
}}}
Also if you find yourself needing a (longer) definition multiple times,
either explicitly referencing the method/function with the definition or
using a `.. SEEALSO::` block is a good way to go IMO. I think this is a
good balance between descriptive, straight-forward, and simple. However
I'm somewhat splitting hairs here.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7477#comment:58>
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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
