#20918: Implement plane partitions class
-------------------------------------+-------------------------------------
Reporter: jessicapalencia | Owner:
Type: task | Status: new
Priority: major | Milestone: sage-7.3
Component: combinatorics | Resolution:
Keywords: plane partition, | Merged in:
days78 |
Authors: Jang Soo Kim, | Reviewers:
Jessica Striker |
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/jessicapalencia/plane_partition | 48f4a4e0efffd4cd38a6d6dbb95df0aaa5c8752c
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by kdilks):
Preliminary doc review:
* In defining the class, I'm not sure what the convention should be, but
arbitrarily choosing {{{A}}} to be the input seems non-standard. Maybe
{{{PP}}}, instead ?
* Also, {{{A}}} is used as the name of the input, and as the size of the
the first element of {{{box_size}}}. In case you decide to ignore me and
stick with {{{A}}}.
* It should be specified how {{{box_size}}} is determined by {{{A}}} if no
parameter is given.
* Nitpicky things, I believe that every doc line needs to be "Return ...",
I think even ones where saying "Check ..." or "Plots..." makes more sense.
The Latex method has "Returns" instead of "Return", and I think some
people think this matters. Also, there's some standard way that arguments
in methods are supposed to be spaced out (ie, always a space after a
comma). Can't remember off-hand if there's supposed to be spaces around
{{{=}}}, or only when you're using two of them together to check equality.
* All of the {{{is_SOMEKINDOFSYMMETRY}}} methods should have an additional
line describing what the symmetry means for somebody that hasn't seen the
definition before. Same with the methods like {{{transpose}}}.
* The {{{PlanePartitions}}} class example mentions something about ASMs of
size 3, which seems like something left over from a template.
* In the docstring for {{{random_element()}}}, it should be formatted so
the HTML documentation will have a hyperlink to the doc string for
{{{random_order_ideal()}}}
--
Ticket URL: <https://trac.sagemath.org/ticket/20918#comment:4>
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 https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
