#13064: The documentation should search methods in classes
------------------------------------+---------------------------------------
Reporter: ppurka | Owner: mvngu
Type: defect | Status: needs_review
Priority: major | Milestone: sage-5.6
Component: documentation | Resolution:
Keywords: documentation | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Travis Scrimshaw | Merged in:
Dependencies: | Stopgaps:
------------------------------------+---------------------------------------
Comment (by tscrim):
Replying to [comment:6 jhpalmieri]:
> I think that for the usage in the ticket description, the functions
`search_src` and `search_def` are much more appropriate than searching the
documentation, which only searches the documentation: the reference
manual, the tutorial, etc. Maybe `search_src` etc. should be better
publicized. There should be a good way to put a note about them on the
[http://www.sagemath.org/doc/reference/search.html search page for the
docs], for instance. Would that be a good idea?
Almost certainly. Something like: "In sage, you can use `search_src` [with
a link to its doc] to find functions in '''all''' of the source code,
including private functions (those that begin with a leading underscore
'`_`')." Possibly also adding: "If there is a module not linked in this
documentation, it is a bug that needs to be reported."
Also `search_def` according to its documentation is the same as
`search_src`.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13064#comment:8>
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.
