#13209: Fix some minor Cayley table documentation problems
---------------------------------------------+------------------------------
Reporter: kcrisman | Owner: joyner
Type: defect | Status: positive_review
Priority: trivial | Milestone: sage-5.8
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:
---------------------------------------------+------------------------------
Changes (by kcrisman):
* status: needs_review => positive_review
Old description:
> Things like `letters` should be `'letters'`, and I'm pretty sure that the
> list in `elements` should be a list of strings? This would be easy for
> people to check - just try out all options!
> {{{
> INPUT:
>
> - ``names`` - the type of names used, values are:
>
> * ``letters`` - lowercase ASCII letters are used
> for a base 26 representation of the elements'
> positions in the list given by :meth:`list`,
> padded to a common width with leading 'a's.
> * ``digits`` - base 10 representation of the
> elements' positions in the list given by
> :meth:`~sage.matrix.operation_table.OperationTable.column_keys`,
> padded to a common width with leading zeros.
> * ``elements`` - the string representations
> of the elements themselves.
> * a list - a list of strings, where the length
> of the list equals the number of elements.
>
> - ``elements`` - default = ``None``. A list of
> elements of the set. This may be used to impose an
> alternate ordering on the elements, perhaps
> when this is used in the context of a particular structure.
> The default is to use whatever ordering is provided by the
> the group, which is reported by the
> :meth:`~sage.matrix.operation_table.OperationTable.column_keys`
> method. Or the ``elements`` can be a subset
> which is closed under the operation. In particular,
> this can be used when the base set is infinite.
> }}}
New description:
Things like `letters` should be `'letters'`, and I'm pretty sure that the
list in `elements` should be a list of strings? This would be easy for
people to check - just try out all options!
{{{
INPUT:
- ``names`` - the type of names used, values are:
* ``letters`` - lowercase ASCII letters are used
for a base 26 representation of the elements'
positions in the list given by :meth:`list`,
padded to a common width with leading 'a's.
* ``digits`` - base 10 representation of the
elements' positions in the list given by
:meth:`~sage.matrix.operation_table.OperationTable.column_keys`,
padded to a common width with leading zeros.
* ``elements`` - the string representations
of the elements themselves.
* a list - a list of strings, where the length
of the list equals the number of elements.
- ``elements`` - default = ``None``. A list of
elements of the set. This may be used to impose an
alternate ordering on the elements, perhaps
when this is used in the context of a particular structure.
The default is to use whatever ordering is provided by the
the group, which is reported by the
:meth:`~sage.matrix.operation_table.OperationTable.column_keys`
method. Or the ``elements`` can be a subset
which is closed under the operation. In particular,
this can be used when the base set is infinite.
}}}
----
Apply [attachment:17436.patch] and [attachment:17437.3.patch].
--
Comment:
Okay, patchbot says yes, and although this isn't how I would have written
it I think it is definitely better than before - we each have our own
style, n'est pas?. Thanks!
Also, I think I have the correct patches selected - let me know if the
description needs to be changed for which patches are to be merged!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13209#comment:14>
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.
