]> granicus.if.org Git - python/commitdiff
Document new directive.
authorGeorg Brandl <georg@python.org>
Thu, 22 Oct 2009 11:28:06 +0000 (11:28 +0000)
committerGeorg Brandl <georg@python.org>
Thu, 22 Oct 2009 11:28:06 +0000 (11:28 +0000)
Doc/documenting/markup.rst

index 4c56cd216518517cc56a51b56dfaf2d6b971c1c9..eec86501d3edc51af714b1d5a5c57d63468e028b 100644 (file)
@@ -626,6 +626,24 @@ units as well as normal text:
 
 --------------
 
+.. 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