From 9d7b75aa5dcab31810d755e3c8204a4e9615cef0 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Thu, 19 Aug 2010 00:02:26 +0200 Subject: [PATCH] Clarify example. --- doc/rest.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/rest.rst b/doc/rest.rst index 2b6eee6b4..693075728 100644 --- a/doc/rest.rst +++ b/doc/rest.rst @@ -325,14 +325,15 @@ directives.) Looking at this example, :: .. function:: foo(x) foo(y, z) - :bar: no + :module: some.module.name Return a line of text input from the user. ``function`` is the directive name. It is given two arguments here, the -remainder of the first line and the second line, as well as one option ``bar`` -(as you can see, options are given in the lines immediately following the -arguments and indicated by the colons). +remainder of the first line and the second line, as well as one option +``module`` (as you can see, options are given in the lines immediately following +the arguments and indicated by the colons). Options must be indented to the +same level as the directive content. The directive content follows after a blank line and is indented relative to the directive start.