Skip to content

Commit

Permalink
docs(derive): Call out 'Command' relationship
Browse files Browse the repository at this point in the history
  • Loading branch information
epage committed Feb 23, 2022
1 parent 77d2de0 commit a7b7d43
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions examples/derive_ref/README.md
Expand Up @@ -9,6 +9,7 @@
4. [Arg Enum Attributes](#arg-enum-attributes)
5. [Possible Value Attributes](#possible-value-attributes)
6. [Doc Comments](#doc-comments)
4. [Tips](#tips)

## Overview

Expand Down Expand Up @@ -359,3 +360,8 @@ them.
- Remove one leading space from each line, even if this attribute is present,
to allow for a space between `///` and the content.
- Remove leading and trailing blank lines

## Tips

- To get access to a `Command` call `CommandFactory::command` (implemented when deriving `Parser`)
- Proactively check for bad `Command` configurations by calling `Command::debug_assert` in a test ([example](../tutorial_derive/05_01_assert.rs))

0 comments on commit a7b7d43

Please sign in to comment.