Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Document how to refer to decorators and decorator methods.

This commit is contained in:
Georg Brandl 2010-08-02 12:54:24 +00:00
parent 283b125551
commit bfc8fe4d2f
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Doc/documenting/markup.rst
View File

@ -205,6 +205,9 @@ The directives are:
Set name of the decorated function to *name*. Set name of the decorated function to *name*.
There is no ``deco`` role to link to a decorator that is marked up with
this directive; rather, use the ``:func:`` role.
.. describe:: class .. describe:: class
Describes a class. The signature can include parentheses with parameters Describes a class. The signature can include parentheses with parameters
@ -226,6 +229,8 @@ The directives are:
Same as ``decorator``, but for decorators that are methods. Same as ``decorator``, but for decorators that are methods.
Refer to a decorator method using the ``:meth:`` role.
.. describe:: opcode .. describe:: opcode
Describes a Python :term:`bytecode` instruction. Describes a Python :term:`bytecode` instruction.