parameters in directive documentation can be now omitted
Details
Details
- Reviewers
kparal - Maniphest Tasks
- T821: generate_directive_docs.py: allow `parameters` to be empty (or missing)
- Commits
- rLTRNbd9f435ec64b: Allow `parameters` to be missing
doit builddocs
Diff Detail
Diff Detail
- Repository
- rLTRN libtaskotron
- Lint
Automatic diff as part of commit; lint not applicable. - Unit
Automatic diff as part of commit; unit tests not applicable.
Comment Actions
I'd rather see meaningful value in doc field or not to use that field at all.
On top of that, the code at the moment explicitly checks that fields cannot be left blank:
for yaml_entry in doc:
if not doc[yaml_entry]:
sys.stderr.write(
"*** ERROR: The %s field can not be left blank.\n"
% yaml_entry)
sys.exit(1)