#1707 Need mechanism to validate command documentation
Closed: Fixed None Opened 8 years ago by jdennis.

We have various tools to validate our source code (make-lint), validate our command API (makeapi), and validate our run-time behavior (make-test). But we are lacking a tool to validate our command documentation.

Such a tool should:

  • Validate every cli command has documentation and the doc has been marked for international translation.

  • Validate every module hosting a cli command has documentation and the doc has been marked for international translation.

  • Validate every help topic has been marked for international translation.

I suggest this logic be incorporated into the makeapi tool and every time the makeapi tool is run the above documentation validation be performed.

The reason the logic belongs in makeapi is because we are only concerned with doc strings belonging to public API commands, makeapi already has the logic to iterate though these public API interfaces.


submitted as patch:

[PATCH 43/43] ticket 1707 - add documentation validation to makeapi tool

Metadata Update from @jdennis:
- Issue assigned to jdennis
- Issue set to the milestone: FreeIPA 2.1.1 (bug fixing)

2 years ago

Login to comment on this ticket.

Metadata