#19041: Better description of docstrings in the developer guide
-------------------------------------+-------------------------------------
Reporter: vdelecroix | Owner:
Type: enhancement | Status: needs_work
Priority: major | Milestone: sage-6.9
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Vincent Delecroix | Reviewers: Nathann Cohen
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/vdelecroix/19041 | 51657979296acca64c5e7b1a9b2521efe89a9bcf
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Comment (by ncohen):
> +1 to this from me. But should we wait if others complain at sage-devel?
Some might argue for example that in Python the function signature shows
if there is no input at all, but output can not be seen directly from it.
How would that be a problem with respect to what you wrote?
I am getting bored, and remembered that we had no 'default' SAT solver in
Sage, so I do the dishonest job of writing a LP SAT solver, that just
solves the LP, so that we get a default one.
So doing, I implement a function called 'nvars'. I'd say that what it
returns is pretty obvious, and already made clear by the first line of the
description. In this situation, function signature or not, I do not think
that a 'OUTPUT' block is needed.
> And when we are at this, maybe take few days to think...? Maybe we
should add for example a paragraph on assumptions? What about `self` - I
have tried to remove them from docstring.
We can wait if you want, I do not mind. Consider the commits up to now as
'positively reviewed' on my behalf.
Nathann
--
Ticket URL: <http://trac.sagemath.org/ticket/19041#comment:6>
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.
