diff options
author | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2003-07-09 18:00:50 +0000 |
---|---|---|
committer | goodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2003-07-09 18:00:50 +0000 |
commit | 5fa4d3b2f10a3fb657a03e04733b4f0a346b6dcc (patch) | |
tree | f131e6021b21b4e2301e80a1b5386e76e86070aa /docs | |
parent | 8c126d1f6afe2e774adb545664ad7c5302e0d5de (diff) | |
download | docutils-5fa4d3b2f10a3fb657a03e04733b4f0a346b6dcc.tar.gz |
updated
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@1578 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs')
-rw-r--r-- | docs/howto/rst-directives.txt | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/howto/rst-directives.txt b/docs/howto/rst-directives.txt index 377ca31ad..85a7b9a4b 100644 --- a/docs/howto/rst-directives.txt +++ b/docs/howto/rst-directives.txt @@ -132,8 +132,11 @@ value ``None``. Three directive function attributes are recognized: argument (raises ``ValueError`` if found), returns ``None`` for valid flag options. - - ``unchanged``: Returns the argument, unchanged. Raises - ``ValueError`` if no argument is found. + - ``unchanged_required``: Returns the text argument, unchanged. + Raises ``ValueError`` if no argument is found. + + - ``unchanged``: Returns the text argument, unchanged. Returns an + empty string ("") if no argument is found. - ``path``: Returns the path argument unwrapped (with newlines removed). Raises ``ValueError`` if no argument is found or if the @@ -142,6 +145,10 @@ value ``None``. Three directive function attributes are recognized: - ``nonnegative_int``: Checks for a nonnegative integer argument, and raises ``ValueError`` if not. + - ``class_option``: Converts the argument into an ID-compatible + string and returns it. Raises ``ValueError`` if no argument is + found. + A further utility function, ``choice``, is supplied to enable options whose argument must be a member of a finite set of possible values. A custom conversion function must be written to use it. |