Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Documentation of CLI parameters should be generated #377

Closed
honzajavorek opened this issue Feb 23, 2016 · 1 comment
Closed

Documentation of CLI parameters should be generated #377

honzajavorek opened this issue Feb 23, 2016 · 1 comment

Comments

@honzajavorek
Copy link
Contributor

At least following -a/--language isn't appearing in docs, but is available in current Dredd version.

Maybe we could even make a little script which takes the output of dredd --help and puts it into docs when building them, so we don't have to care about this manually.

honzajavorek added a commit that referenced this issue Mar 12, 2016
honzajavorek added a commit that referenced this issue Mar 12, 2016
This was referenced Mar 12, 2016
@honzajavorek
Copy link
Contributor Author

This has been fixed now with Dredd 1.0.8, but just by copy-pasting current output of --help to the usage.md file. I will consider this issue to be closed once we have better and automatic documentation of CLI in place. My idea would be:

  1. Put description of CLI parameters from usage.md into a separate file (e.g. cli.md), which would be a product of compilation and would be ignored by Git.
  2. Link the new file from existing docs.
  3. Write a script, which takes existing options, their descriptions and defaults and produces a nicely formatted Markdown file.
  4. Make the script part of the build process.

@honzajavorek honzajavorek changed the title Some CLI parameters are not properly documented Documentation of CLI parameters should be generated Mar 15, 2016
honzajavorek added a commit that referenced this issue Apr 27, 2016
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Projects
None yet
Development

No branches or pull requests

1 participant