aboutsummaryrefslogtreecommitdiff
path: root/describe.py
diff options
context:
space:
mode:
authorThomas Coffee <tcoffee@google.com>2017-03-27 10:39:26 -0700
committerJon Wayne Parrott <jonwayne@google.com>2017-03-27 10:39:26 -0700
commit2f245374da9c895dbd8bb0423e98707d51b53414 (patch)
tree9678ed4597d1ac879a9e4a87e99301163f3ff178 /describe.py
parente833b79ffee531ae64e11175718bb2fffc504950 (diff)
downloadgoogle-api-python-client-2f245374da9c895dbd8bb0423e98707d51b53414.tar.gz
Fix method doc signatures for multiline required parameters (#374)
* Fix method doc signatures for multiline required parameters. Existing doc generator failed to recognize parameters as required when parameter descriptions extended over more than one line. Besides presenting incorrect information, resulting inconsistencies broke checks for automated sample generation. * Regen docs
Diffstat (limited to 'describe.py')
-rwxr-xr-xdescribe.py14
1 files changed, 11 insertions, 3 deletions
diff --git a/describe.py b/describe.py
index e3881aec4..3aaaa50df 100755
--- a/describe.py
+++ b/describe.py
@@ -200,15 +200,23 @@ def method_params(doc):
args = doclines[begin+1:]
parameters = []
+ pname = None
+ desc = ''
+ def add_param(pname, desc):
+ if pname is None:
+ return
+ if '(required)' not in desc:
+ pname = pname + '=None'
+ parameters.append(pname)
for line in args:
m = re.search('^\s+([a-zA-Z0-9_]+): (.*)', line)
if m is None:
+ desc += line
continue
+ add_param(pname, desc)
pname = m.group(1)
desc = m.group(2)
- if '(required)' not in desc:
- pname = pname + '=None'
- parameters.append(pname)
+ add_param(pname, desc)
parameters = ', '.join(parameters)
else:
parameters = ''