Opened 10 years ago
Closed 10 years ago
#12645 closed defect (fixed)
Fix rst markup for sage/combinat/sf/sf.py (and add to manual) and sage/structure/dynamic_class.py
Reported by: | SimonKing | Owned by: | mvngu |
---|---|---|---|
Priority: | minor | Milestone: | sage-5.0 |
Component: | documentation | Keywords: | |
Cc: | nthiery | Merged in: | sage-5.0.beta8 |
Authors: | Simon King | Reviewers: | Nicolas M. Thiéry |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description
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.
Attachments (1)
Change History (6)
comment:1 Changed 10 years ago by
- Status changed from new to needs_review
Changed 10 years ago by
comment:2 Changed 10 years ago by
- Reviewers set to Nicolas M. Thiéry
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.
comment:3 Changed 10 years ago by
- Status changed from needs_review to positive_review
Your additions look fine to me!
comment:4 Changed 10 years ago by
- Summary changed from Fix rst markup for sage/combinat/sf/sf.py and sage/structure/dynamic_class.py and put the former into the manuel to Fix rst markup for sage/combinat/sf/sf.py (and add to manual) and sage/structure/dynamic_class.py
comment:5 Changed 10 years ago by
- Merged in set to sage-5.0.beta8
- Resolution set to fixed
- Status changed from positive_review to closed
Ready for review.