matklad / once_cell

Rust library for single assignment cells and lazy statics without macros
Apache License 2.0
1.87k stars 109 forks source link

Add MSRV to readme #247

Closed Stargateur closed 1 year ago

Stargateur commented 1 year ago

I think that good to put MSRV in the README.

Fix somehow https://github.com/matklad/once_cell/issues/201

matklad commented 1 year ago

I think this is already sufficiently documented in

This extra information is very useful for users who want to learn the context about a specific policy, but I don't think it's useful enough for enough of people to spend valuable README.md space on that.

Stargateur commented 1 year ago

The only problem of putting it in the code is that user need to look rust documentation, I generally include the readme in the documentation crate level. Maybe you will be interested to include the readme in crate documentation ?

This extra information is very useful for users who want to learn the context about a specific policy, but I don't think it's useful enough for enough of people to spend valuable README.md space on that.

Feel free to close, it's your project haha ^^ was just an idea

matklad commented 1 year ago

Yeah, the duplication between lib.rs and readme is unfortunate, but I hold lib.rs as the source of truth, and try to avoid using readme for anything. We used to duplicate the docs between readme and lib.rs, but then pared that down.

Stargateur commented 1 year ago

I generally use that #![doc = include_str!("../readme.md")] but I don't have your experience yet haha