Context Navigation

← Previous Ticket
Next Ticket →

#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:

Status badges

Description (last modified by chapoton)

As the subject says. This needs to be coordinated with #8797.

Apply:

trac_8793_new_version_2013_10.patch

Attachments (6)

trac_8793_v0.patch (18.0 KB) - added by knsam 8 years ago.
trac_8793_doc_add_prep1.patch (15.0 KB) - added by knsam 8 years ago.: Apply on top of v0.
trac_8793_doc_add_prep2.patch (8.2 KB) - added by knsam 8 years ago.: Apply on top of both v0 and doc_add_prep1
trac_8793_doc_addon3.patch (21.5 KB) - added by chapoton 8 years ago.
trac_8793_doc_addon4.patch (12.9 KB) - added by chapoton 8 years ago.
trac_8793_new_version_2013_10.patch (10.8 KB) - added by chapoton 8 years ago.

Download all attachments as: .zip

Change History (22)

comment:1 Changed 11 years ago by mvngu

Description modified (diff)

Changed 8 years ago by knsam

Attachment trac_8793_v0.patch added

comment:2 Changed 8 years ago by knsam

Dependencies set to #14183

comment:3 Changed 8 years ago by knsam

Keywords beginner doctest documentation added

Changed 8 years ago by knsam

Attachment trac_8793_doc_add_prep1.patch added

Apply on top of v0.

Changed 8 years ago by knsam

Attachment trac_8793_doc_add_prep2.patch added

Apply on top of both v0 and doc_add_prep1

comment:4 Changed 8 years ago by knsam

Description modified (diff)
Status changed from new to needs_review

comment:5 Changed 8 years ago by chapoton

I have added one more patch, that removes whitespaces and makes some changes in import section.

Changed 8 years ago by chapoton

Attachment trac_8793_doc_addon3.patch added

comment:6 Changed 8 years ago by vbraun

Description modified (diff)

comment:7 Changed 8 years ago by vbraun

Authors set to Frédéric Chapoton
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 jdemeyer

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.