From: Georg Brandl <georg@python.org>
Date: Thu, 22 Oct 2009 11:28:06 +0000 (+0000)
Subject: Document new directive.
X-Git-Tag: v2.7a1~283
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d032912ac15115a3d6093741970c76cff26ebfbf;p=python

Document new directive.
---

diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index 4c56cd2165..eec86501d3 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -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