Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.1.3 - 2022-12-28

Added

For arguments that take a value, the argument value name (Arg::get_value_names()) is now included in the generated Markdown. (#11)
For arguments that have default values (Arg::get_default_values()) , those default values are mentioned in the generated Markdown. (#11)

Changed

The rendered Markdown for PossibleValue literal values now uses code styling instead of emphasized styling, for consistency with other literally-what-the-user-types help content (e.g. option or subcommand names). (#11)

0.1.2 - 2022-12-28

Added

Generated markdown for PossibleValue values will now include the PossibleValue::get_help() content, if it exists. (#8)

This means that documentation comments present on enum variants that use #[derive(clap::ValueEnum)] will be summarized in the generated Markdown documentation.

0.1.1 - 2022-12-26

Added

Added new basic example to README.md. (#4)
Added new 'Usage Convention: CommandLineHelp.md' section to README.md (#4)
Add list of projects using clap-markdown and CommandLineHelp.md convention to README.md. (#5)

0.1.0 - 2022-12-17

Added

Added new ./docs/examples/ directory to the repository, with Rust source code for the complex_app.rs example program, and the generated complex-app.md Markdown content for that program. (#1)

Changed

Modify generated Markdown. (#1)

The following changes are present in the generated Markdown:
- Added 'Command-Line Help for {name}' header
- Include Arg::get_possible_values() information in arguments and options documentation.
- Renamed 'Commands' label to 'Subcommands'
- Added small footer at the bottom stating that the document was generated automatically by clap-markdown.

0.0.1 - 2022-12-13

Initial release of clap-markdown.