Docs: Relevant results not on top when searching for class

Issue #3031 resolved
Bérenger Enselme created an issue

Today I needed to read the docs for the Query class. So I typed "Query" in the search box. The first result was "sqlalchemy.orm.session.Session.query" which led me here: http://docs.sqlalchemy.org/en/rel_0_9/orm/session.html?highlight=query#sqlalchemy.orm.session.Session.query

At that point I got "Return a new Query object corresponding to this Session." but "Query" is not a link so I went back to the list where I then had to scroll two pages to finally find "sqlalchemy.orm.query.Query".

Shouldn't a class whose name matches the search term exactly be on, or near the top ?

Comments (2)

  1. Mike Bayer repo owner

    unfortunately the search for the documentation is provided by a project called sphinx, and we have no way to improve upon the admittedly mediocre functioning of this javascript library.

    as far as "query" being linked, that is definitely part of a long effort to eventually get everything in the docs to be linked, which has been ongoing for some years and has made many areas of the documentation more navigable in spite of the size of the docs and the lackluster search feature. pull requests are welcome here.

  2. Log in to comment