diff options
| author | Georg Brandl <georg@python.org> | 2010-08-02 12:54:24 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-08-02 12:54:24 (GMT) |
| commit | bfc8fe4d2f6b2296a16b7f7d9634437c40950dd8 (patch) | |
| tree | b01bade86b9d5a19f71797ca69e9f38f63b1aabd /Doc/documenting | |
| parent | 283b1255516c67332f28a0dff4fb28aa93f07d11 (diff) | |
| download | cpython-bfc8fe4d2f6b2296a16b7f7d9634437c40950dd8.zip cpython-bfc8fe4d2f6b2296a16b7f7d9634437c40950dd8.tar.gz cpython-bfc8fe4d2f6b2296a16b7f7d9634437c40950dd8.tar.bz2 | |
Document how to refer to decorators and decorator methods.
Diffstat (limited to 'Doc/documenting')
| -rw-r--r-- | Doc/documenting/markup.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index e48bb01..b4421cb 100644 --- a/Doc/documenting/markup.rst +++ b/Doc/documenting/markup.rst @@ -205,6 +205,9 @@ The directives are: 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 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. + Refer to a decorator method using the ``:meth:`` role. + .. describe:: opcode Describes a Python :term:`bytecode` instruction. |