#13834: Clean up linestyle arguments throughout Sage
-------------------------------+--------------------------------------------
Reporter: ppurka | Owner: jason, was
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-wishlist
Component: graphics | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: | Merged in:
Dependencies: | Stopgaps:
-------------------------------+--------------------------------------------
Comment (by ppurka):
Hello, Thanks for looking into this ticket. I will be able to do a more
thorough review only later this week. With a casual look at the patch, I
have the following comments about the formatting. In general, you can look
at the [http://www.sagemath.org/doc/developer/conventions.html Sage
developer's guide] on how to format certain things.
1. Try to limit the lengths of your lines to about 80 characters. An
example of how code can be written to fit within that limit is given in
[http://www.python.org/dev/peps/pep-0008/#maximum-line-length PEP8]. Very
long lines are hard to read and edit. Long strings can also be broken up
like this
{{{
ValueError("this is a valueerror for %d"
"something something %s.\n"
"something else"%(20, 'abc'))
}}}
2. Don't try to catch the `ValueError` that is raised inside the new
function `get_matplotlib_linestyle`. So you can get rid of the `try` block
and `import verbose`.
3. In the docstrings, write the strings inside double backticks like this
{{{
- ``linestyle`` - (default: ``'solid'``) The style of the line, which
is one of
``'dashed'``, ``'dotted'``, ``'solid'`` ....
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13834#comment:5>
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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.