[docs] [issue36913] Missing documentation for decorators

Tomer Vromen report at bugs.python.org
Tue May 14 03:35:28 EDT 2019

New submission from Tomer Vromen <tomerv at 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).


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

Python tracker <report at bugs.python.org>

More information about the docs mailing list