Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve docs, add doctests in power_series* #16199

Closed
rwst opened this issue Apr 21, 2014 · 10 comments
Closed

improve docs, add doctests in power_series* #16199

rwst opened this issue Apr 21, 2014 · 10 comments

Comments

@rwst
Copy link
Contributor

rwst commented Apr 21, 2014

Improve documentation of power series.

Component: doctest coverage

Keywords: series

Author: Ralf Stephan

Branch/Commit: 3ea4f9b

Reviewer: Peter Bruin

Issue created by migration from https://trac.sagemath.org/ticket/16199

@rwst rwst added this to the sage-6.2 milestone Apr 21, 2014
@rwst
Copy link
Contributor Author

rwst commented Apr 21, 2014

@rwst
Copy link
Contributor Author

rwst commented Apr 21, 2014

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

@rwst
Copy link
Contributor Author

rwst commented Apr 21, 2014

Commit: cc54f6e

@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.2, sage-6.3 May 6, 2014
@pjbruin

This comment has been minimized.

@pjbruin
Copy link
Contributor

pjbruin commented May 21, 2014

Reviewer: Peter Bruin

@pjbruin
Copy link
Contributor

pjbruin commented May 21, 2014

comment:4

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.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 22, 2014

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 22, 2014

Changed commit from cc54f6e to 3ea4f9b

@rwst
Copy link
Contributor Author

rwst commented May 22, 2014

comment:6

Thanks for the review.

@vbraun
Copy link
Member

vbraun commented May 23, 2014

Changed branch from u/rws/improve_docs__add_doctests_in_power_series_ to 3ea4f9b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants