Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend help command to list modules with brief explanation #234

Open
nichtich opened this issue Apr 7, 2016 · 2 comments
Open

Extend help command to list modules with brief explanation #234

nichtich opened this issue Apr 7, 2016 · 2 comments

Comments

@nichtich
Copy link
Member

nichtich commented Apr 7, 2016

For instance

catmandu help export           # describes Catmandu::Cmd::export
catmandu help export [to] JSON # describes Catmandu::Exporter::JSON
catmandu help exporters        # should list all exporters

catmandu info --exporter already gives exporters but duplicated if multiple of same name are found in INC and for help another format would be better, e.g.

 JSON: a JSON exporter
Multi: export you data to multiple exporters
 Stat: a statistical export
  TSV: a tab-delimited TSV exporter

By the way Catmandu::Cmd::info needs some extension anyway.

@nichtich
Copy link
Member Author

nichtich commented Sep 2, 2016

catmandu help export and catmandu help export <exporter> are already implemented, only catmandu help [exporters|importers|fixes|stores|validators] based on catmandu info is missing. The latter is not suitable for easy help but for further processing of the result list.

@nichtich
Copy link
Member Author

nichtich commented Mar 2, 2018

  • catmandu help fixes (could be extended with some additional help text)
  • catmandu help exporters
  • catmandu help importers
  • catmandu help stores
  • catmandu help validators

The implementation could also be used for #261

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant