#17693: mutable poset: a data structure for asymptotic expressions
-------------------------------------+-------------------------------------
Reporter: dkrenn | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.5
Component: misc | Resolution:
Keywords: asymptotics | Merged in:
Authors: Daniel Krenn | Reviewers:
Report Upstream: N/A | Work issues:
Branch: u/dkrenn/asy | Commit:
/mutable-poset | 19fd1556a56a6d250ca464c385e7960ac715b2ae
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by jmantysalo):
Replying to [comment:20 dkrenn]:
> Replying to [comment:18 jmantysalo]:
> > > The developer guide says
> > >
> > > An INPUT and an OUTPUT block describing the input/output of the
function. This is not optional.
> >
> > True. But I don't think if it has been thinked that "no input" must be
documented. Is it in other places? Or should this part of developer guide
be changed?
>
> I would keep it. (At the moment) the developer guide says to include it
and I find it very nice to have constistent docstrings starting with one-
liner, INPUT, OUTPUT, more details, EXAMPLES, ...
This is discussed at #19041. But don't let this stop coding -- Sage will
propably never get finished so that questions like this would have The
Final Answer.
> > And should for example docstring of `.cardinality()` really contain
`OUTPUT`-block saying that output type is sage's `Integer`?
>
> What do you suggest?
Every `cardinality()` should return `Integer`. For other integer-valued
functions there were discussion about `int` vs. `Integer` without
consensus.
I don't know. For input it is explicitly said that the docstring can say
"x in integer", not "x must be `Integer` or `int`". These are hard
questions, as what is "clear" varies from one person to other.
--
Ticket URL: <http://trac.sagemath.org/ticket/17693#comment:21>
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.
For more options, visit https://groups.google.com/d/optout.
