-
-
Notifications
You must be signed in to change notification settings - Fork 490
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
The documentation should search methods in classes #13064
Comments
comment:1
I don't think the problem is that it cannot search in methods. For instance, if you try
you'll see plenty of methods show up. Are you positive that |
comment:2
My guess was that maybe it only searches and indexes methods which are present in global scope. I will have to look more carefully to see why it is missing some of the methods. |
comment:3
The problem (in this particular case) is that the documentation for these finite fields are not included/built because there's no references in a |
comment:4
Sure, go ahead. |
comment:5
I've added a finite field |
Author: Travis Scrimshaw |
comment:6
I think that for the usage in the ticket description, the functions |
comment:7
Replying to @jhpalmieri:
Definitely a good idea. I wasn't aware of this |
comment:8
Replying to @jhpalmieri:
Almost certainly. Something like: "In sage, you can use Also |
comment:9
Replying to @tscrim:
Actually they are different functions. Their input and output formats are similar. The |
comment:10
Those I'm imagining text like "You can also run Re |
comment:11
Here's a sample patch. This changes Sage so it uses its own "search.html" page instead of the default one. The difference between the default one and the one in the patch is this: --- local/lib/python/site-packages/Sphinx-1.1.2-py2.7.egg/sphinx/themes/basic/search.html 2012-11-17 10:34:58.000000000 -0800
+++ devel/sage/doc/common/themes/sage/search.html 2012-11-17 22:11:12.000000000 -0800
@@ -31,6 +31,12 @@
function will automatically search for all of the words. Pages
containing fewer words won't appear in the result list.{% endtrans %}
</p>
+ <p>
+ {% trans %}Note also that you can also call "search_src(...)"
+ while running Sage to search Sage's source code. You can also
+ browse Sage's source code by calling "hg_sage.serve()" while running
+ Sage.{% endtrans %}
+ </p>
<form action="" method="get">
<input type="text" name="q" value="" />
<input type="submit" value="{{ _('search') }}" /> |
Attachment: trac_13064-search.patch.gz |
comment:12
Attachment: trac_13064-finite_rings_doc-ts.patch.gz I've rebased over #13180. I'm happy with the change to the search page. |
Dependencies: #13180 |
comment:13
This applies cleanly for me on 5.5.rc0, so let's try again. For patchbot: Apply: trac_13064-finite_rings_doc-ts.patch, trac_13064-search.patch |
Changed author from Travis Scrimshaw to John Palmieri, Travis Scrimshaw |
comment:15
Sorry for sitting on this for so long. I have nothing else to add to this. |
Reviewer: Travis Scrimshaw, Punarbasu Purkayastha |
comment:16
Thank you for doing the final review on this. Best, Travis |
Changed reviewer from Travis Scrimshaw, Punarbasu Purkayastha to Punarbasu Purkayastha |
Merged: sage-5.7.beta4 |
The documentation here http://www.sagemath.org/doc/reference/search.html should be able to search methods (those not starting with
_
) in the classes. For instance, the following search http://www.sagemath.org/doc/reference/search.html?q=integer_representation gives zero results even thoughinteger_representation
is a valid method for an element ofGF(2^p)
.Depends on #13180
CC: @sagetrac-sage-combinat
Component: documentation
Author: John Palmieri, Travis Scrimshaw
Reviewer: Punarbasu Purkayastha
Merged: sage-5.7.beta4
Issue created by migration from https://trac.sagemath.org/ticket/13064
The text was updated successfully, but these errors were encountered: