From bfc8fe4d2f6b2296a16b7f7d9634437c40950dd8 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Mon, 2 Aug 2010 12:54:24 +0000 Subject: Document how to refer to decorators and decorator methods. --- Doc/documenting/markup.rst | 5 +++++ 1 file changed, 5 insertions(+) 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. -- cgit v0.12