Lack of samples

[Wandalen]

Thanks for open source. Any samples?

[schneiderfelipe]

Do you mean something like tests
https://github.com/tailhook/humantime/blob/12ce6f50894a56a410b390e5608ac9db8afe2407/src/duration.rs#L345-L379
or
https://github.com/tailhook/humantime/blob/12ce6f50894a56a410b390e5608ac9db8afe2407/src/duration.rs#L384-L385

[jnhyatt]

I'm having a hard time finding examples for how to use this crate. I'm trying to format a standard library duration into a string like "1h 38m 12s". I've checked:

• Module level docs: couple claims about capabilities, no usage example or links to such
• examples/ folder: nonexistent
• Docs on Duration and FormattedDuration: explains parsing but not formatting
• Docs on format_duration: finally getting somewhere, but the docs are extremely sparse

It'd be nice to add examples, but at the very least should really have a usage example in the module-level docs. One way to make it really discoverable would be to include the readme as the module-level docs. That would mean you'd get a usage example on:

• crates.io
• github
• docs.rs

...on the front page. This is really easy to do: #![doc = include_str!("../README.md")] and ensures consistency and discoverability.

[djc]

Hi, I've recently taken over maintenance for this crate but will mainly be "passive", as in, reviewing pull requests.