#9108: Mark long doctests in rings/polynomial/symmetric_ideal
-----------------------------------+----------------------------------------
Reporter: leif | Owner: malb
Type: defect | Status: positive_review
Priority: minor | Milestone: sage-4.4.3
Component: commutative algebra | Keywords: time-out, doctest, symmetric
ideal, symmetric_ideal
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------------+----------------------------------------
Comment(by leif):
Replying to [comment:6 SimonKing]:
> So, if the next release will be soon, I suggest to take Leif's patch as
it is. But I think in the long run, a new example (like the one above) is
needed.
Feel free to add additional (short) tests... ;-)
Perhaps on another ticket?
> Concerning line lengths: Does this only concern the first line of the
doc strings? I know that my first lines tend to be rather lengthy, as I
learnt that the basic description of the functionality should be given in
the first line of the doc string (this is why I don't do a line wrap).
I just noticed that e.g. some parameter description lines are wider (net
width).
Also, some are "marked" {{{(optional)}}}; the current practice seems to be
repeating the default value from the function definition, too, i.e.
{{{
``param`` -- (type, default: some_value) further description...
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9108#comment:9>
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.
