search

pacak / bpaf

Command line parser with applicative interface
337 stars 17 forks source link

doc: improve documentation of `cargo_helper` #346

Closed Boshen closed 5 months ago

Boshen commented 5 months ago

By commenting what "pretty" actually is.

I thought "pretty" is some special value 😅

pacak commented 5 months ago

Documentation is my weak point, thank you for pointing out the problems :)

docs2 folder is somewhat special. It is generated from docs2 crate and all the examples are actually tested. To make this change you need to update files in docs2/src/cargo_helper and run cargo test -p docs2. This runs the tests and, if everything matches, updates the markdown file in src/docs2.

I can make this change myself if you find the process too confusing.

Boshen commented 5 months ago

Updated.

The rehearsal is good, I know what to do next time 😁