#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 | 77adc8be695d4ba2f6f13762f9477320626e4f57
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by tscrim):
Replying to [comment:4 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 ?
You can always be more explicit, such as `array` too.
> * 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.
You should use the declarative form "Return"/"Plot" instead of
"Returns"/"Plots". However, it does not, strictly speaking, have to say
"Return" (especially if it does not actually return anything).
> 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.
It depends on where this is done. If it is as input, then no spaces, but
it if is an assignment of a variable, then there should be spaces.
> * 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()}}}
What (I think) Kevin is saying, in case it is not clear, is to use
{{{:meth:`~sage.combinat.posets.posets.FinitePoset.random_order_ideal`}}}.
--
Ticket URL: <https://trac.sagemath.org/ticket/20918#comment:7>
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.
