More consistent readme for msrv #2336
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2336 +/- ##
=====================================
Coverage 79.5% 79.5%
=====================================
Files 123 123
Lines 21365 21365
=====================================
Hits 17004 17004
Misses 4361 4361 ☔ View full report in Codecov by Sentry. |
| observability tools. | ||
|
|
||
| *Compiler support: [requires `rustc` 1.70+][msrv]* | ||
| *[Supported Rust Versions](#supported-rust-versions)* |
There was a problem hiding this comment.
This section needs some changes, the MSRV varies across crates—some require Rust 1.70, while others need 1.71.
There was a problem hiding this comment.
good point! Let me address it next.
| //! compiler version is 1.49, the minimum supported version will not be | ||
| //! increased past 1.46, three minor versions prior. Increasing the minimum | ||
| //! supported compiler version is not considered a semver breaking change as | ||
| //! long as doing so complies with this policy. |
There was a problem hiding this comment.
should this be in README.md instead of lib.rs?
There was a problem hiding this comment.
that is something I expect to resolve next. My thinking is to make everything in lib.rs and have readme just point to docs.rs/crate
| infrastructure, or runtime environment. Crucially, the storage and visualization | ||
| of telemetry is intentionally left to other tools. | ||
|
|
||
| *[Supported Rust Versions](#supported-rust-versions)* |
There was a problem hiding this comment.
nit - do we need this line, given that the information is already clear and easy to find in the README?
There was a problem hiding this comment.
kept it for consistency, and also there'll be more content to be added to this readme in future.
Co-authored-by: Lalit Kumar Bhasin <[email protected]>
Co-authored-by: Lalit Kumar Bhasin <[email protected]>
Co-authored-by: Lalit Kumar Bhasin <[email protected]>
2 participants
Towards #1306
This PR fixes some inconsistencies, but not all. There'll be further follow ups to make everything consistent.