Opened 8 years ago

Closed 8 years ago

#16199 closed enhancement (fixed)

improve docs, add doctests in power_series*

Reported by: rws Owned by:
Priority: major Milestone: sage-6.3
Component: doctest coverage Keywords: series, doctest
Cc: Merged in:
Authors: Ralf Stephan Reviewers: Peter Bruin
Report Upstream: N/A Work issues:
Branch: 3ea4f9b (Commits, GitHub, GitLab) Commit: 3ea4f9bfc3c1acb6cb9eaa8e7a8ffa41779a6181
Dependencies: Stopgaps:

Status badges

Description (last modified by pbruin)

Improve documentation of power series.

Change History (7)

comment:1 Changed 8 years ago by rws

  • Branch set to u/rws/improve_docs__add_doctests_in_power_series_

comment:2 Changed 8 years ago by rws

  • Commit set to cc54f6eaf4ddff77eb66d448b13ff20bb3e91fbb
  • Status changed from new to needs_review

New commits:

310200714053: doctests added; typos fixed
8356a6fmove TODO into ticket 16194
abc97b4Merge branch 'develop' into t/14053/bring_doctest_coverage_for_rings_power_series__to_100_
cc54f6eimprove docvumentation; add doctests

comment:3 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:4 Changed 8 years ago by pbruin

  • Description modified (diff)
  • Reviewers set to Peter Bruin

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.

comment:5 Changed 8 years ago by git

  • Commit changed from cc54f6eaf4ddff77eb66d448b13ff20bb3e91fbb to 3ea4f9bfc3c1acb6cb9eaa8e7a8ffa41779a6181

Branch pushed to git repo; I updated commit sha1. New commits:

e935206Merge branch 'develop' into t/16199/improve_docs__add_doctests_in_power_series_
3ea4f9b16199: documentation cosmetics

comment:6 Changed 8 years ago by rws

  • Status changed from needs_review to positive_review

Thanks for the review.

comment:7 Changed 8 years ago by vbraun

  • Branch changed from u/rws/improve_docs__add_doctests_in_power_series_ to 3ea4f9bfc3c1acb6cb9eaa8e7a8ffa41779a6181
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.