Opened 7 years ago
Closed 7 years ago
#8266 closed enhancement (fixed)
Improve documentation for word objects
Reported by: | slabbe | Owned by: | slabbe |
---|---|---|---|
Priority: | major | Milestone: | sage-4.3.4 |
Component: | documentation | Keywords: | |
Cc: | abmasse | Merged in: | sage-4.3.4.alpha1 |
Authors: | Sébastien Labbé | Reviewers: | Alexandre Blondin Massé |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description
Documentation of words and word objects contains only pickle tests and lacks good examples :
sage: words? ... Docstring: A class consisting of constructors for several famous words. TESTS:: sage: from sage.combinat.words.word_generators import WordGenerator sage: MyWordBank = WordGenerator() sage: type(loads(dumps(MyWordBank))) <class 'sage.combinat.words.word_generators.WordGenerator'>
sage: w = Word(range(5)) sage: w? ... Docstring: TESTS:: sage: w = Word([0,1,1,0]) sage: w == loads(dumps(w)) True
Attachments (3)
Change History (8)
Changed 7 years ago by
comment:1 Changed 7 years ago by
- Cc abmasse added
- Status changed from new to needs_review
comment:2 Changed 7 years ago by
#7619 now have a positive review... so this patch can now get reviewed
comment:3 Changed 7 years ago by
Looked at the patch. Since it is a documentation-only patch, all tests passed. I made sure that the patch of ticket #7619 was applied first. I still made a few minor changes.
- I replaced "pyhon" by "Python" everywhere I found it.
- I added ":" after a NOTE block that was not appearing in the documentation.
- I replaced strange unicode characters by " at the end of Sébastien's patch.
- I replaced the latex output of "w." by a code-font "w."
If Sébastien agrees with my changes, I allow him to set the ticket to "positive review".
comment:4 Changed 7 years ago by
- Reviewers set to Alexandre Blondin Massé
- Status changed from needs_review to positive_review
Thanks for the review Alex. I don't know where those strange characters came from... I added one patch to fix two of those characters (I really wanted ``
not ").
Since I my patch fix only two characters in the doc and because I agree with your changes and because your gave a positive review to my first patch, I think I can change the status of this ticket to positive review.
comment:5 Changed 7 years ago by
- Merged in set to sage-4.3.4.alpha1
- Resolution set to fixed
- Status changed from positive_review to closed
Depends on #7619.