[Python-checkins] r75602 - python/trunk/Doc/documenting/markup.rst

[georg.brandl]

Author: georg.brandl
Date: Thu Oct 22 13:28:06 2009
New Revision: 75602

Log:
Document new directive.

Modified:
   python/trunk/Doc/documenting/markup.rst

Modified: python/trunk/Doc/documenting/markup.rst
==============================================================================
--- python/trunk/Doc/documenting/markup.rst	(original)
+++ python/trunk/Doc/documenting/markup.rst	Thu Oct 22 13:28:06 2009
@@ -626,6 +626,24 @@
 
 --------------
 
+.. describe:: impl-detail
+
+   This directive is used to mark CPython-specific information.  Use either with
+   a block content or a single sentence as an argument, i.e. either ::
+
+      .. impl-detail::
+
+         This describes some implementation detail.
+
+         More explanation.
+
+   or ::
+
+      .. impl-detail:: This shortly mentions an implementation detail.
+
+   "\ **CPython implementation detail:**\ " is automatically prepended to the
+   content.
+
 .. describe:: seealso
 
    Many sections include a list of references to module documentation or