#12891: Invite for contributing a doctest, if a user reads an untested function
or
method
------------------------------------------+---------------------------------
Reporter: SimonKing | Owner: was
Type: enhancement | Status: new
Priority: major | Milestone: sage-5.1
Component: user interface | Resolution:
Keywords: documentation untested | Work issues:
Report Upstream: N/A | Reviewers:
Authors: | Merged in:
Dependencies: | Stopgaps:
------------------------------------------+---------------------------------
Changes (by SimonKing):
* type: PLEASE CHANGE => enhancement
Comment:
Replying to [comment:3 drkirkby]:
> I'm guessing this will be a sort of meta-ticket, where you open another
ticket for an undocumented function, and provide a link here. Hopefully
then writing the doctest on the other ticket. Is that what you had in
mind?
Not at all. As the ticket description says: The aim is to change the
behaviour of `obj?` in Notebook and ipython interface (I am afraid both
needs to be done) so that people trying to read the documentation of obj
are encouraged to contribute a doctest (of course only if such doctest is
missing).
In other words, this is not a (meta-)ticket about doctests but a ticket
about a potential approach to get people to start contributing to sage by
writing doctests (this is why I chose the component "user interface", not
"doctest").
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12891#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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
