classification
Title: Search does not intelligently handle module.function queries on docs.python.org
Type: Stage:
Components: Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: JonathansCorner.com, georg.brandl
Priority: normal Keywords:

Created on 2009-05-14 19:00 by JonathansCorner.com, last changed 2009-05-17 10:15 by georg.brandl. This issue is now closed.

Messages (2)
msg87755 - (view) Author: Jonathan Hayward (JonathansCorner.com) Date: 2009-05-14 18:59
The search function on docs.python.org does not intelligently search the
library for a query in the form "module.function". For instance, in
searching for information on (say) socket.bind(), neither a search query
of "socket.bind()" nor "socket.bind" finds any results. I need to search
for "socket bind" / "bind socket" to get results (or possibly "socket"
or "bind" alone to get a larger number of less focused results.) This is
particularly interesting as the page I am interested in contains the
string "socket.bind" and in fact the snippet that appears on the search
result page for the #1 match is: "...onnection, and *address* is the
address bound to the socket on the other end of the connection. ..
method:: socket.bind(address) Bind the socket to *address*. The socket
must not already be bound. (The format of *address* depen..."

It would be nice if searches for module.function, module.CONSTANT,
module.object, module.object.function, etc. would work for search terms
as objects are named in the API.

(A much easier, if imperfect approximation, would be to treat \W as
breaking words as spaces are treated now, so that e.g. periods in
queries would be internally treated as spaces and a search for
"socket.bind" would be treated as "socket bind" and possibly get
surprisingly good results; see
http://docs.python.org/search.html?q=socket+bind .)

Jonathan
http://JonathansCorner.com/
msg87978 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-05-17 10:15
This is already done in Sphinx trunk, and will be used for Python as
soon as it is released.
History
Date User Action Args
2009-05-17 10:15:33georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg87978
2009-05-14 19:00:01JonathansCorner.comcreate