#15013: update docstrings in logic module
-------------------------------------------------+-------------------------
Reporter: pmscurek | Owner:
Type: task | Status:
Priority: major | needs_work
Component: documentation | Milestone: sage-5.12
Keywords: logic, documentation, | Resolution:
docstring | Merged in:
Authors: Paul Scurek | Reviewers: William
Report Upstream: N/A | Stein
Branch: | Work issues:
Dependencies: #14951, #14952 | Commit:
| Stopgaps:
-------------------------------------------------+-------------------------
Changes (by jdemeyer):
* status: positive_review => needs_work
Comment:
There are problems building the documentation:
{{{
dochtml.log:[logic ]
/mazur/release/merger/sage-5.12.beta4/local/lib/python2.7/site-
packages/sage/logic/booleval.py:docstring of sage.logic.booleval:9:
WARNING: Literal block expected; none found.
dochtml.log:[logic ]
/mazur/release/merger/sage-5.12.beta4/local/lib/python2.7/site-
packages/sage/logic/booleval.py:docstring of
sage.logic.booleval.eval_f:14: WARNING: Literal block expected; none
found.
dochtml.log:[logic ]
/mazur/release/merger/sage-5.12.beta4/local/lib/python2.7/site-
packages/sage/logic/booleval.py:docstring of
sage.logic.booleval.eval_formula:16: WARNING: Literal block expected; none
found.
dochtml.log:[logic ]
/mazur/release/merger/sage-5.12.beta4/local/lib/python2.7/site-
packages/sage/logic/propcalc.py:docstring of sage.logic.propcalc:25:
WARNING: Literal block expected; none found.
}}}
The correct syntax is (note the use of a single vs. double colons)
{{{
EXAMPLES:
Some explantory text::
sage: some_doctest
}}}
--
Ticket URL: <http://trac.sagemath.org/ticket/15013#comment:8>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/groups/opt_out.
