Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit bfc8fe4

Browse files
committed
Document how to refer to decorators and decorator methods.
1 parent 283b125 commit bfc8fe4

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

Doc/documenting/markup.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,9 @@ The directives are:
205205

206206
Set name of the decorated function to *name*.
207207

208+
There is no ``deco`` role to link to a decorator that is marked up with
209+
this directive; rather, use the ``:func:`` role.
210+
208211
.. describe:: class
209212

210213
Describes a class. The signature can include parentheses with parameters
@@ -226,6 +229,8 @@ The directives are:
226229

227230
Same as ``decorator``, but for decorators that are methods.
228231

232+
Refer to a decorator method using the ``:meth:`` role.
233+
229234
.. describe:: opcode
230235

231236
Describes a Python :term:`bytecode` instruction.

0 commit comments

Comments
 (0)