cht-conf icon indicating copy to clipboard operation
cht-conf copied to clipboard

Document each action

Open abbyad opened this issue 5 years ago • 1 comments

In https://github.com/medic/medic-conf/pull/270 the actions listed in the README were cleaned up so that the formatting is a bit more consistent. It would be useful to app builders to have a place where all actions are listed out with descriptions on how to use them.

abbyad avatar Nov 28 '19 22:11 abbyad

I would ask that we extend the fn spec (from {requiredInstance, execute} so that they are available in code (probably as a short and long description). This allows us to automatically generate help more usefully and specifically at runtime:

> medic-conf --available-actions #or whatever it's called
...
<action-name>: <short description>
<action-name>: <short description>
...
> medic-conf <action-name> --help
<action-name>:
<long-description>
> 

etc

SCdF avatar Nov 29 '19 09:11 SCdF