#18618: sandpile revisions
-------------------------------------+-------------------------------------
Reporter: dperkinson | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.8
Component: graph theory | Resolution:
Keywords: sandpile | Merged in:
Authors: David Perkinson | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/dperkinson/sandpile_revisions | 1c2361fca1173001c8d31d6049319e2263fe5faa
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by tscrim):
Some quick comments:
- You don't need `INPUT:` and `OUTPUT:` blocks if there is no input or
output.
- You should format the `INPUT:` blocks like this:
{{{
INPUT:
- ``foo`` -- the bar
- ``param`` -- (default: 5) an integer we do something with that is
typically
the value 5, mainly I'm blabbing on to make this a longer line
- ``opt`` -- (optional) some optional argument
}}}
- Make classes "new-style" `class Foo(object):`.
- You should find a way to automize the `help()` method. It can be very
painful to manage this by hand.
- For notes, you can use
{{{
.. NOTE::
This is a note. Everything should be one level further indented than
before.
}}}
- Similar for `.. WARNING::`
- You can't duplicate references. Instead reference them by
`[NameOfReference]_`.
- The patchbot's error is saying the documentation doesn't build; in
particular there is an indentation either needed or missing from
somewhere.
--
Ticket URL: <http://trac.sagemath.org/ticket/18618#comment:14>
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.
