Skip to content

Commit

Permalink
Merge pull request clap-rs#2818 from epage/docs-panic
Browse files Browse the repository at this point in the history
docs: Point people to common panic practices
  • Loading branch information
epage committed Oct 6, 2021
2 parents e62a92f + a77e12e commit 5512c90
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Expand Up @@ -86,4 +86,6 @@ There are a few goals of `clap` that I'd like to maintain throughout contributio
- This is also true of generating help and usage information (although *slightly* less stringent, as the program is about to exit)
* Try to be cognizant of memory usage
- Once parsing is complete, the memory footprint of `clap` should be low since the main program is the star of the show
* `panic!` on *developer* error, exit gracefully on *end-user* error
* `panic!` on *developer* error
(e.g. [apps](https://github.com/clap-rs/clap/blob/62eff1f8d3394cef819b4aa7b23a1032fc584f03/src/build/app/debug_asserts.rs) and [args](https://github.com/clap-rs/clap/blob/62eff1f8d3394cef819b4aa7b23a1032fc584f03/src/build/arg/debug_asserts.rs)),
exit gracefully on *end-user* error

0 comments on commit 5512c90

Please sign in to comment.