#16199: improve docs, add doctests in power_series*
-------------------------------------+-------------------------------------
       Reporter:  rws                |        Owner:
           Type:  enhancement        |       Status:  needs_review
       Priority:  major              |    Milestone:  sage-6.3
      Component:  doctest coverage   |   Resolution:
       Keywords:  series, doctest    |    Merged in:
        Authors:  Ralf Stephan       |    Reviewers:  Peter Bruin
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  u/rws/improve_docs__add_doctests_in_power_series_|  
cc54f6eaf4ddff77eb66d448b13ff20bb3e91fbb
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------
Changes (by pbruin):

 * reviewer:   => Peter Bruin


Old description:



New description:

 Improve documentation of power series.

--

Comment:

 Looks good.  Just a few small comments (all about methods of the class
 `PowerSeries`):
 - The examples block in `__hash__()` is not correctly indented.
 - In `_cmp_c_impl()`, put single backquotes also around the "g" in "Magma
 would declare f and g unequal.`
 - In `is_unit()` and several other methods below it, please try to split
 the first sentence(s) into two paragraphs so that the first one is just
 one line (or at most two lines) long.
 - In `sqrt()` it might be slightly better to say "Return a square root of
 self."
 Once you fixed these you can set it to positive review.

--
Ticket URL: <http://trac.sagemath.org/ticket/16199#comment:4>
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.

Reply via email to