#11387: Typos in the main README
-----------------------------+----------------------------------------------
Reporter: kini | Owner: mvngu
Type: defect | Status: needs_review
Priority: trivial | Milestone: sage-4.7.1
Component: documentation | Keywords: typo, README
Work_issues: | Upstream: N/A
Reviewer: Kelvin Li | Author: Kelvin Li, Keshav Kini
Merged: | Dependencies:
-----------------------------+----------------------------------------------
Comment(by ltw):
Replying to [comment:4 kini]:
> No, the more formatting fixes the better. By all means, please don't
hold back! :) I wonder why you're wrapping to 76 columns, though. I
believe PEP 8 suggests 79 for code and 72 for documentation and other
flowed text.
Thanks for the encouragement! I'm new to Sage development (and open-source
development, for that matter). :-) I'm not quite sure where the line is
between "beneficial but massive cleanup that no one had bothered to do"
versus "lots of differencing noise that makes patches hard to review." In
other words, I couldn't decide whether my patch was "scope creeping"
beyond the original intent of the ticket.
I knew about 79 characters for code, but I didn't know about 72 for
documentation. I naively used the series of hyphens on line 12, which is
76 characters long, as my guide... I will come back with a new patch.
> By the way, it's probably not technically allowed for you to review a
patch you suggested...
Oh, I thought my reviewing your original patch was considered reviewing.
Does the concept of reviewing apply to whole tickets, rather than patches,
in which case I obviously can't review myself? :-)
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11387#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 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.
