[Python-checkins] r83528 - python/branches/py3k/Doc/documenting/markup.rst

[georg.brandl]

Author: georg.brandl
Date: Mon Aug  2 14:54:24 2010
New Revision: 83528

Log:
Document how to refer to decorators and decorator methods.

Modified:
   python/branches/py3k/Doc/documenting/markup.rst

Modified: python/branches/py3k/Doc/documenting/markup.rst
==============================================================================
--- python/branches/py3k/Doc/documenting/markup.rst	(original)
+++ python/branches/py3k/Doc/documenting/markup.rst	Mon Aug  2 14:54:24 2010
@@ -205,6 +205,9 @@
 
          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 @@
 
    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.