diff options
| author | Georg Brandl <georg@python.org> | 2009-10-22 11:28:06 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-10-22 11:28:06 (GMT) |
| commit | d032912ac15115a3d6093741970c76cff26ebfbf (patch) | |
| tree | ac866e186f87ab9cd91b46a284cbd43b65ec4886 | |
| parent | a0547227782bb9ff0aec6afc92b56d6edd92c987 (diff) | |
| download | cpython-d032912ac15115a3d6093741970c76cff26ebfbf.zip cpython-d032912ac15115a3d6093741970c76cff26ebfbf.tar.gz cpython-d032912ac15115a3d6093741970c76cff26ebfbf.tar.bz2 | |
Document new directive.
| -rw-r--r-- | Doc/documenting/markup.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst index 4c56cd2..eec8650 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 |