Diffusion Sink 50bed81038f1

Improve documentation of SinkSH

Authored by rnicole on Aug 3 2018, 2:59 PM.

Description

Improve documentation of SinkSH

Summary:

  • Add support for positional arguments, options, flags in the syntax tree
  • Add automatic generation of usage string

TODO:

  • Better document the --reduce option in the list command
  • Get the parent command for sub-commands so we could show help for trace on and not just on
  • Pass the syntax to the implementation of the command so commands can easily show help on wrong usage. Also, SyntaxTree could do automatic input validation in the future, this could also help.
  • Even with the new documentation, some command could still be confusing. Should we add some usage examples?

Reviewers: cmollekopf

Reviewed By: cmollekopf

Tags: Sink

Differential Revision: https://phabricator.kde.org/D14547

Details

Committed
cmollekopfAug 3 2018, 3:10 PM
Reviewer
cmollekopf
Differential Revision
D14547: Improve documentation of SinkSH
Parents
R9:ad3dc2212731: Fixed typo
Branches
Unknown
Tags
Unknown