classification
Title: Can't find "map" with search on docs.python.org
Type: behavior Stage:
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum, raulcd, rhettinger, terry.reedy
Priority: normal Keywords:

Created on 2021-10-05 15:51 by gvanrossum, last changed 2021-10-08 21:32 by terry.reedy.

Messages (4)
msg403245 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2021-10-05 15:51
I was looking for the docs for 'map' and tried to use the search box on docs.python.org. This gave a lot of things whose name started with or contained 'map', but the entry for the builtin map() function was hidden really far down under the heading "Builtin Functions" (https://docs.python.org/3.10/library/functions.html?highlight=map) rather than deep-linking to the entry I was looking for (https://docs.python.org/3.10/library/functions.html#map).

I'm sure that some tweak to the index builder could fix this, in general, for all builtin functions and types (many of which I imagine suffer from the effect -- having a short name that is used a lot as a part of other names).
msg403251 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2021-10-05 16:35
I'm surprised no one else noticed this until now.  

The doc search finds some entries such as: "sum", "min", "max", and "enumerate".  However, it is missing others such as: "map" and "filter".
msg403254 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2021-10-05 17:24
> I'm surprised no one else noticed this until now.  

Most people probably just use Google and read whatever comes up. I was looking whether the official docs for map mentioned that map is actually an iterator class. (They don't.)
msg403509 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2021-10-08 21:32
The iterator classes are not identified as such because being a class instead of a function, such as a generator function, is a CPython implementation detail, not a language requirement.

Searching for filter seems as bad -- builtin filter is about the 60th hit.  Builtins should be listed first instead.
History
Date User Action Args
2021-10-08 21:32:49terry.reedysetnosy: + terry.reedy
messages: + msg403509
2021-10-05 17:24:09gvanrossumsetmessages: + msg403254
2021-10-05 16:35:34rhettingersetnosy: + rhettinger
messages: + msg403251
2021-10-05 15:59:25raulcdsetnosy: + raulcd
2021-10-05 15:51:22gvanrossumcreate