Opened 11 years ago
Closed 7 years ago
#8793 closed enhancement (fixed)
clean up documentation of logic/boolformula.py
Reported by: | mvngu | Owned by: | mvngu |
---|---|---|---|
Priority: | major | Milestone: | sage-5.13 |
Component: | documentation | Keywords: | beginner doctest documentation |
Cc: | Merged in: | sage-5.13.beta5 | |
Authors: | Frédéric Chapoton | Reviewers: | Volker Braun, Nathann Cohen |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | #14183, #14951 | Stopgaps: |
Description (last modified by )
Attachments (6)
Change History (22)
comment:1 Changed 11 years ago by
- Description modified (diff)
Changed 8 years ago by
comment:2 Changed 8 years ago by
- Dependencies set to #14183
comment:3 Changed 8 years ago by
- Keywords beginner doctest documentation added
Changed 8 years ago by
comment:4 Changed 8 years ago by
- Description modified (diff)
- Status changed from new to needs_review
comment:5 Changed 8 years ago by
I have added one more patch, that removes whitespaces and makes some changes in import section.
Changed 8 years ago by
comment:6 Changed 8 years ago by
- Description modified (diff)
comment:7 Changed 8 years ago by
- Reviewers set to Volker Braun
- Status changed from needs_review to positive_review
Please refrain from unnecessary whitespace changes in the future.
comment:8 Changed 8 years ago by
- Milestone changed from sage-5.11 to sage-5.12
- Status changed from positive_review to needs_work
The documentation doesn't even build correctly:
dochtml.log:[logic ] /mazur/release/merger/sage-5.11.rc0/local/lib/python2.7/site-packages/sage/logic/boolformula.py:docstring of sage.logic.boolformula:6: WARNING: Bullet list ends without a blank line; unexpected unindent. dochtml.log:[logic ] /mazur/release/merger/sage-5.11.rc0/local/lib/python2.7/site-packages/sage/logic/boolformula.py:docstring of sage.logic.boolformula:6: WARNING: Bullet list ends without a blank line; unexpected unindent. dochtml.log:[logic ] /mazur/release/merger/sage-5.11.rc0/local/lib/python2.7/site-packages/sage/logic/boolformula.py:docstring of sage.logic.boolformula.BooleanFormula.dist_not:11: WARNING: Inline literal start-string without end-string. dochtml.log:[logic ] /mazur/release/merger/sage-5.11.rc0/local/lib/python2.7/site-packages/sage/logic/boolformula.py:docstring of sage.logic.boolformula.BooleanFormula.dist_ors:11: WARNING: Inline literal start-string without end-string.
comment:9 Changed 8 years ago by
Why end lines with
.::
I think these would be rendered as .:
You probably want
. ::
Changed 8 years ago by
comment:10 Changed 8 years ago by
- Description modified (diff)
- Status changed from needs_work to needs_review
ok, here is patch that makes sure that the doc build.
It also changes .::
into . ::
It also remove self from the input in most functions
It also makes the code in pep8 standard
Needs review.
comment:11 Changed 8 years ago by
- Reviewers changed from Volker Braun to Volker Braun, Nathann Cohen
- Status changed from needs_review to positive_review
It all looks good to me now :-)
Nathann
comment:12 Changed 8 years ago by
- Dependencies changed from #14183 to #14183, #14951
- Status changed from positive_review to needs_work
This should be rebased to sage-5.12.beta1 + #14951.
Changed 8 years ago by
comment:13 Changed 8 years ago by
- Description modified (diff)
- Status changed from needs_work to needs_review
ok, here is a brand new patch, to be applied alone.
for the patchbots apply trac_8793_new_version_2013_10.patch
comment:14 Changed 8 years ago by
apply trac_8793_new_version_2013_10.patch
comment:15 Changed 7 years ago by
- Status changed from needs_review to positive_review
Good to go !
Nathann
comment:16 Changed 7 years ago by
- Merged in set to sage-5.13.beta5
- Resolution set to fixed
- Status changed from positive_review to closed
Apply on top of v0.