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

Fix rst markup for sage/combinat/sf/sf.py (and add to manual) and sage/structure/dynamic_class.py #12645

Closed
simon-king-jena opened this issue Mar 9, 2012 · 5 comments

Comments

@simon-king-jena
Copy link
Member

In the two files named in the title, the .. topic:: directive is improperly used (namely as ..topic: without the blank space and with only one colon), and moreover it should actually be .. rubric:: instead.

Moreover, some lists are indented too much, and in some case an empty line is missing, such as

    Further things to do:
     - Use UniqueRepresentation to get rid of all the manual cache handling for the bases
     - Devise a mechanism so that pickling bases of symmetric functions pickles
       the coercions which have a cache.

versus

    Further things to do:

    - Use UniqueRepresentation to get rid of all the manual cache handling for the bases
    - Devise a mechanism so that pickling bases of symmetric functions pickles
      the coercions which have a cache.

In some places a double colon :: was missing.

I also suggest to use the .. todo:: markup more often.

And last but not least, I believe that sage/combinat/sf/sf.py should be put into the reference manual.

CC: @nthiery

Component: documentation

Author: Simon King

Reviewer: Nicolas M. Thiéry

Merged: sage-5.0.beta8

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

@simon-king-jena
Copy link
Member Author

comment:1

Ready for review.

@nthiery
Copy link
Contributor

nthiery commented Mar 9, 2012

comment:2

Attachment: trac_12645-fix_rst_markup-sk.patch.gz

While we were at it, I did a couple minor changes around yours. Since the patch was short anyway, I allowed myself to refresh my review directly in it rather than writing a reviewer's patch. Please browse through, and if you are happy you can set a positive review on my behalf.

@nthiery
Copy link
Contributor

nthiery commented Mar 9, 2012

Reviewer: Nicolas M. Thiéry

@simon-king-jena
Copy link
Member Author

comment:3

Your additions look fine to me!

@jdemeyer jdemeyer changed the title Fix rst markup for sage/combinat/sf/sf.py and sage/structure/dynamic_class.py and put the former into the manuel Fix rst markup for sage/combinat/sf/sf.py (and add to manual) and sage/structure/dynamic_class.py Mar 10, 2012
@jdemeyer
Copy link

Merged: sage-5.0.beta8

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