From 031daabcc4bb023ff54bd76dd1418bbe3bcff022 Mon Sep 17 00:00:00 2001
From: Jason Gerard DeRose <jderose@redhat.com>
Date: Fri, 26 Sep 2008 23:41:51 +0000
Subject: [PATCH] 371: Added examples to parse_param_spec() docstring and
 changed syntax guide into a reStructuredText table

---
 ipalib/frontend.py | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/ipalib/frontend.py b/ipalib/frontend.py
index afc02066c..5fd27116d 100644
--- a/ipalib/frontend.py
+++ b/ipalib/frontend.py
@@ -152,10 +152,25 @@ def parse_param_spec(spec):
     required, and whether the param is multivalue according the following
     syntax:
 
-    name => required=True, multivalue=False
-    name? => required=False, multivalue=False
-    name+ => required=True, multivalue=True
-    name* => required=False, multivalue=True
+    ======  =====  ========  ==========
+    Spec    Name   Required  Multivalue
+    ======  =====  ========  ==========
+    'var'   'var'  True      False
+    'var?'  'var'  False     False
+    'var*'  'var'  False     True
+    'var+'  'var'  True      True
+    ======  =====  ========  ==========
+
+    For example,
+
+    >>> parse_param_spec('login')
+    ('login', {'required': True, 'multivalue': False})
+    >>> parse_param_spec('gecos?')
+    ('gecos', {'required': False, 'multivalue': False})
+    >>> parse_param_spec('telephone_numbers*')
+    ('telephone_numbers', {'required': False, 'multivalue': True})
+    >>> parse_param_spec('group+')
+    ('group', {'required': True, 'multivalue': True})
 
     :param spec: A spec string.
     """