Skip to content

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

@simon-king-jena

Description

@simon-king-jena

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

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions