]> granicus.if.org Git - python/commitdiff
Document how to refer to decorators and decorator methods.
authorGeorg Brandl <georg@python.org>
Mon, 2 Aug 2010 12:54:24 +0000 (12:54 +0000)
committerGeorg Brandl <georg@python.org>
Mon, 2 Aug 2010 12:54:24 +0000 (12:54 +0000)
Doc/documenting/markup.rst

index e48bb01f724b826bcb83aa29ee75c0e7bf38889b..b4421cb23b05c94f371168b08d82e1430fcb82b1 100644 (file)
@@ -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.