#13209: Fix some minor Cayley table documentation problems
---------------------------------------------+------------------------------
Reporter: kcrisman | Owner: joyner
Type: defect | Status: needs_review
Priority: trivial | Milestone: sage-5.6
Component: group theory | Resolution:
Keywords: cayley doc table beginner | Work issues:
Report Upstream: N/A | Reviewers: Karl-Dieter
Crisman
Authors: Kannappan Sampath | Merged in:
Dependencies: | Stopgaps:
---------------------------------------------+------------------------------
Comment (by kcrisman):
Looking better! Thanks for working with the often-multistep process.
A couple things:
* Very minor - you may want to name the patch after the ticket issue,
like `trac_13209-cayley.patch` or something. No biggie.
* Slightly less minor - the commit message is very long. Try to have a
short one first, then in the next lines more detail. I think the limit is
88 characters or whatever the standard terminal window is. I thought this
was in the [http://www.sagemath.org/doc/developer/ developer guide] but I
can't find it...
* Same issue with the documentation changes. They look good, but you
made some lines too long. Try to keep them the same length as the current
lines. This is a big enough deal to make it "needs work".
* Also, although you are probably right about the "able to be coerced"
thing, it would be nice to make it explicit that strings work. That is
why I originally opened the ticket. Maybe "such as strings" or something.
I know this is just my personal preference, but I think it's likely that
it's a use case; people may not be able to easily get the exact elements
they want for passing in in a given order (if it's a strange order) but
it's easy to type those elements in, in which case they will need to be
strings, like in one of the examples.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13209#comment:11>
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.
