Allow `parameters` to be missing
ClosedPublic

Authored by lbrabec on Jul 25 2016, 12:56 PM.

Details

Summary

parameters in directive documentation can be now omitted

Test Plan

doit builddocs

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.
lbrabec retitled this revision from to Allow `parameters` to be missing.Jul 25 2016, 12:56 PM
lbrabec updated this object.
lbrabec edited the test plan for this revision. (Show Details)
lbrabec added a reviewer: kparal.
kparal requested changes to this revision.Jul 25 2016, 3:36 PM

Nice. Could you also make

parameters: {}

work?

This revision now requires changes to proceed.Jul 25 2016, 3:36 PM

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)
kparal accepted this revision.Jul 26 2016, 6:56 AM

OK, so let's do it like this.

This revision is now accepted and ready to land.Jul 26 2016, 6:56 AM
Closed by commit rLTRNbd9f435ec64b: Allow `parameters` to be missing (authored by Lukas Brabec <lbrabec@redhat.com>). · Explain WhyJul 26 2016, 7:04 AM
This revision was automatically updated to reflect the committed changes.