Add short code example to README about snafu HOT 5 CLOSED

I would pass on skeptic and use doc-comment instead. It is well motivated and has zero dependencies: https://blog.guillaume-gomez.fr/articles/2019-04-13+Keeping+Rust+projects%27+README.md+code+examples+up-to-date (I use doc-comment in several of my crates now, and plan to use it in more.)

from snafu.

I really don’t want to put code in the README because it can bitrot quickly. There’s two links in the README, the first of which links directly to an example which is tested in CI:

• https://docs.rs/snafu/0.4.1/snafu/

Is there some way I can rewrite the text to encourage you to click on that link?

from snafu.

Well, I might be able to use some nightly features to automatically test the README:

• https://github.com/abonander/readme-doctest-poc/blob/master/src/lib.rs

from snafu.

You can do automatic README testing using skeptic. It's pretty cool. I use it here: https://github.com/svenstaro/mt940-rs

from snafu.

Yeah, the few times I’ve attempted to use skeptic I’ve not succeeded and been put off by the whole thing.

I’ve got a local branch using doc-comment (and using it for external markdown files for the user’s guide).

from snafu.