New submission from Tomer Vromen <tom...@gmail.com>:

The documentation for decorators (for methods and classes) is pretty lacking.

Searching for "decorator" ( https://docs.python.org/3/search.html?q=decorator ) 
brings up a lot of libraries that use decorators, but no documentation 
explaining what they are and how they work. The documentation should have a 
dedicated page for explaining decorators, and this should be the 1st search 
result.

--

In the meantime, then search should give as a 1st result a link to the 
definition of decorator in the glossary: 
https://docs.python.org/3.7/glossary.html#glossary

Actually, it seems that there is no way to directly link to a paragraph in the 
glossary - so that should be added as well.

In general, it would be nice if a search for some term X would show as a 1st 
result the definition of X in the glossary (if it exists there).

Thanks!

----------
assignee: docs@python
components: Documentation
messages: 342435
nosy: docs@python, tomerv
priority: normal
severity: normal
status: open
title: Missing documentation for decorators
type: enhancement
versions: Python 3.7

_______________________________________
Python tracker <rep...@bugs.python.org>
<https://bugs.python.org/issue36913>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to