[docs] Search Improvement Suggestion - Methods

[Kim Ford]

Hi there,

I know there might be a way to get what I’m suggesting, but I haven’t found it, so I’m sharing it here.

In brief, searching for things like “Dictionary Methods”, “List Methods”, and “String Methods” returns long lists or search results.

Searching for any of the above should result in the top search result being a page that contains the methods.  Or at least there should be some easy to find links in the docs that point to such things.

Sadly, I wind up using Google and usually find myself on a different site than the official Python documentation.  While some of these sites are okay, I find the content in the Python documentation to be best.  If only I can find it!

I hope I don’t come across as sounding like a whiner, but… whaaa whaa whaaa :) 

Best,

Kim

To clarify I start my searches from here:  file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/index.html# <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/index.html#>

This like is provided during Python 3.7 install and I’ve bookmarked it for “easy” reference.

An example is when searching for “List Methods”, there are 239 results.

In order to actually find List Methods in the docs, I need to do this:

1. Navigate to the General Index page
2. Click L (for List)
3. Search on the page for List (there are 19 matches)
4. Get frustrated as there is not section for Methods to click on

list <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/glossary.html#term-list>
assignment, target <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-6>
comprehensions <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-12>
deletion target <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-21>
display <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-12>
empty <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-12>
expression <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-80>, [1] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-1>, [2] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-2>
object <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/c-api/list.html#index-0>, [1] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-21>, [2] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-23>, [3] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/datamodel.html#index-23>, [4] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-12>, [5] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-33>, [6] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-35>, [7] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-38>, [8] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-10>
target <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/compound_stmts.html#index-6>, [1] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/compound_stmts.html#index-6>, [2] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-5>
type, operations on <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-22>
list (built-in class) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#list>
List (class in typing) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/typing.html#typing.List>
list (pdb command) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/pdb.html#pdbcommand-list>
list comprehension <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/glossary.html#term-list-comprehension>
list() (imaplib.IMAP4 method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/imaplib.html#imaplib.IMAP4.list>
(multiprocessing.managers.SyncManager method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/multiprocessing.html#multiprocessing.managers.SyncManager.list>
(nntplib.NNTP method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/nntplib.html#nntplib.NNTP.list>
(poplib.POP3 method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/poplib.html#poplib.POP3.list>
(tarfile.TarFile method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/tarfile.html#tarfile.TarFile.list>
LIST_APPEND (opcode) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/dis.html#opcode-LIST_APPEND>
list_dialects() (in module csv) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/csv.html#csv.list_dialects>
list_folders() (mailbox.Maildir method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/mailbox.html#mailbox.Maildir.list_folders>
(mailbox.MH method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/mailbox.html#mailbox.MH.list_folders>


At least String has a section called methods:

string
PyObject_Str (C function) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/c-api/object.html#index-2>
__format__() (object method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/datamodel.html#index-74>
__str__() (object method) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/datamodel.html#index-72>
conversion <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/datamodel.html#index-74>, [1] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/simple_stmts.html#index-3>
format() (built-in function) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/functions.html#index-4>
formatted literal <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/lexical_analysis.html#index-20>
formatting, printf <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-33>
immutable sequences <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/datamodel.html#index-18>
interpolated literal <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/lexical_analysis.html#index-20>
interpolation, printf <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-33>
item <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-36>
methods <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-30>
module <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/locale.html#index-6>
object <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-26>, [1] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-35>, [2] <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/reference/expressions.html#index-38>
object representation <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/extending/newtypes.html#index-3>
str (built-in class) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-28>
str() (built-in function) <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/functions.html#index-10>
text sequence type <file:///Library/Frameworks/Python.framework/Versions/3.7/Resources/English.lproj/Documentation/library/stdtypes.html#index-26>



Sent via Migadu.com, world's easiest email hosting
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20180713/13fcda72/attachment-0001.html>