#17818: Interface to FindStat
-------------------------------------+-------------------------------------
Reporter: mantepse | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.6
Component: interfaces | Resolution:
Keywords: FindStat | Merged in:
Authors: Martin Rubey | Reviewers:
Report Upstream: N/A | Work issues:
Branch: public/findstat- | Commit:
interface | 05a08edd8a0f0a8532a1fba6fead85e4d97e42de
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by vdelecroix):
Plenty of documentation issues! Did you try to run `make doc`?
1. After `INPUT:`, `OUTPUT:` there must be a blankline.
2. `TODO` sections must be indented, i.e.
{{{
.. TODO::
we definitely should do this and that
}}}
3. The first line of the documentation should be an imperative and start
with an uppercase. Replace
{{{
returns the name of the collection
}}}
with
{{{
Return the name of the collection
}}}
And no point at the end of this first sentence.
4. This is wrong and will raise an error during the creation of the
documentation.
{{{
EXAMPLES::
A particular statistic can be called by its St-number or number::
}}}
There should be two colon only if the next block is indented. In that
case it should be
{{{
EXAMPLES:
A particular statistic can be called by its St-number or number::
}}}
And in the following you forgot a colon
{{{
To search for a distribution, send a list of lists, or a single pair:
}}}
There is a lot of useful information in the
[http://www.sagemath.org/doc/developer/coding_basics.html#documentation-
strings developer guide].
--
Ticket URL: <http://trac.sagemath.org/ticket/17818#comment:27>
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.
