Add doc for new doc field syntax.

1 files changed, 7 insertions, 0 deletions

diff --git a/doc/markup/desc.rst b/doc/markup/desc.rst
index 4df9f621..c51c6211 100644
--- a/doc/markup/desc.rst
+++ b/doc/markup/desc.rst
@@ -245,6 +245,8 @@ Info field lists
 
 .. versionadded:: 0.4
 
+.. XXX this is only for Python
+
 Inside object description directives, reST field lists with these fields are
 recognized and formatted nicely:
 
@@ -272,6 +274,11 @@ explained by an example::
       :type limit: integer or None
       :rtype: list of strings
 
+It is also possible to combine parameter type and description, if the type is a
+single word, like this::
+
+   :param integer limit: maximum number of stack frames to show
+
 This will render like this:
 
    .. function:: format_exception(etype, value, tb[, limit=None])