You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.
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.
The text was updated successfully, but these errors were encountered:
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:
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.
Link the new file from existing docs.
Write a script, which takes existing options, their descriptions and defaults and produces a nicely formatted Markdown file.
Make the script part of the build process.
honzajavorek
changed the title
Some CLI parameters are not properly documented
Documentation of CLI parameters should be generated
Mar 15, 2016
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.The text was updated successfully, but these errors were encountered: