#8915: improve documentation on combinat.dyck_words
-------------------------------+--------------------------------------------
Reporter: zabrocki | Owner: zabrocki
Type: defect | Status: needs_review
Priority: trivial | Milestone: sage-4.4.2
Component: documentation | Keywords: dyck_words
Author: Mike Zabrocki | Upstream: N/A
Reviewer: Minh Van Nguyen | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Changes (by mvngu):
* reviewer: => Minh Van Nguyen
Old description:
> documentation in several functions are missing description
> {{{
> def associated_parenthesis(self, pos):
> """
> EXAMPLES::
>
> sage: DyckWord([1, 0]).associated_parenthesis(0)
> 1
> }}}
>
> Working on patch
New description:
documentation in several functions are missing description
{{{
def associated_parenthesis(self, pos):
"""
EXAMPLES::
sage: DyckWord([1, 0]).associated_parenthesis(0)
1
}}}
Apply patches in this order:
1.
[http://trac.sagemath.org/sage_trac/attachment/ticket/8915/trac8915.2.patch
trac8915.2.patch]
1.
[http://trac.sagemath.org/sage_trac/attachment/ticket/8915/trac_8915-reviewer.patch
trac_8915-reviewer.patch]
--
Comment:
The patch
[http://trac.sagemath.org/sage_trac/attachment/ticket/8915/trac8915.2.patch
trac8915.2.patch] is the same as
[http://trac.sagemath.org/sage_trac/attachment/ticket/8915/trac8915.patch
trac8915.patch], but with the ticket number and a commit message. Changes
proposed by the reviewer patch:
* Explain the input wherever possible.
* Don't go over 79 characters per line wherever possible. This is in
accordance with the style guide [http://www.python.org/dev/peps/pep-0008/
PEP 008].
* Cross reference functions wherever possible.
* Some typo fixes.
So only my patch needs review by anyone but me. If my reviewer patch is
OK, then the whole ticket is good to go.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8915#comment:3>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
