openstack
/
openstack-doc-tools
Code Issues Proposed changes

autohelp: avoid help strings on multiple lines 

Multiple lines means dealing with indentation, which is complicated and
not a problem for automatically generated tables. Use the same helptext
generation in autohelp than in extract_swift_flags.

Change-Id: Ibd64d3f0387c3e7f1f3aacf57be5f0c97addf5c9
This commit is contained in:
Gauvain Pocentek 2015-11-20 16:38:40 +01:00
parent 8391493619
commit 50589f3343
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
autogenerate_config_docs/autohelp.py
View File

@ -397,9 +397,11 @@ def write_files(package_name, options, target, output_format):
if not option.help: if not option.help:
option.help = "No help text available for this option." option.help = "No help text available for this option."
helptext = option.help.strip().replace('\n', ' ')
helptext = ' '.join(helptext.split())
item = (option.dest, item = (option.dest,
_sanitize_default(option), _sanitize_default(option),
"(%s) %s" % (type(option).__name__, option.help.strip())) "(%s) %s" % (type(option).__name__, helptext))
items.append(item) items.append(item)
env['items'].append(items) env['items'].append(items)