#15096: corrupted documentation (global fix)
-----------------------------------+-------------------------------
Reporter: zimmerma | Owner:
Type: defect | Status: needs_review
Priority: trivial | Milestone: sage-5.13
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Paul Zimmermann | Reviewers: Minh Van Nguyen
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
-----------------------------------+-------------------------------
Changes (by mvngu):
* reviewer: => Minh Van Nguyen
Old description:
> In Sage 5.11:
> {{{
> sage: from sage.structure.proof.proof import get_flag
> sage: get_flag?
> Type: function
> String Form:<function get_flag at 0x17e0398>
> File: /home/zimmerma/Downloads/sage-5.11/local/lib/python2.7/site-
> packages/sage/structure/proof/proof.py
> Definition: get_flag(t=None, subsystem=None)
> Docstring:
> Used for easily determining the correct proof flag to use.
>
> EXAMPLES:
> sage: from sage.structure.proof.proof import get_flag sage:
> get_flag(False) False sage: get_flag(True) True sage: get_flag()
> True sage: proof.all(False) sage: get_flag() False
> }}}
> Clearly the example part is corrupted.
>
> This ticket aims to fix globally similar problems in the whole library.
>
> '''Apply:''' [[attachment:trac_15096.patch]]
New description:
In Sage 5.11:
{{{
sage: from sage.structure.proof.proof import get_flag
sage: get_flag?
Type: function
String Form:<function get_flag at 0x17e0398>
File: /home/zimmerma/Downloads/sage-5.11/local/lib/python2.7/site-
packages/sage/structure/proof/proof.py
Definition: get_flag(t=None, subsystem=None)
Docstring:
Used for easily determining the correct proof flag to use.
EXAMPLES:
sage: from sage.structure.proof.proof import get_flag sage:
get_flag(False) False sage: get_flag(True) True sage: get_flag()
True sage: proof.all(False) sage: get_flag() False
}}}
Clearly the example part is corrupted.
This ticket aims to fix globally similar problems in the whole library.
'''Apply:''' [[attachment:trac_15096_2.patch]]
--
Comment:
OK, so I didn't split Paul's patch into multiple patches. It turns out
that you don't need to include patches for files under the `sage/logic`
directory. Someone just needs to review the updated patch
[[attachment:trac_15096_2.patch]].
--
Ticket URL: <http://trac.sagemath.org/ticket/15096#comment:7>
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.
