-
Notifications
You must be signed in to change notification settings - Fork 541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Inconsistent crate features documentation #1434
Comments
@edmorley Thank you for reporting this. Would you be interested in making a PR to straighten it out? |
edmorley
added a commit
to edmorley/chrono
that referenced
this issue
Feb 23, 2024
The `chrono` crate makes use of several Cargo features: https://github.com/chronotope/chrono/blob/02c68d69a1ff8e6461384a770b87737b5096eae3/Cargo.toml#L19-L46 These features are documented in both `README.md` and the rustdocs in `lib.rs, however, the lists in each place were missing some features and also inconsistent in their descriptions. I've also removed the unused `[wasm-bindgen]` link definition, and made the usage of code blocks vs links more consistent. Fixes chronotope#1434.
edmorley
added a commit
to edmorley/chrono
that referenced
this issue
Feb 23, 2024
The `chrono` crate makes use of several Cargo features: https://github.com/chronotope/chrono/blob/02c68d69a1ff8e6461384a770b87737b5096eae3/Cargo.toml#L19-L46 These features are documented in both `README.md` and the rustdocs in `lib.rs, however, the lists in each place were missing some features and also inconsistent in their descriptions. I've also removed the unused `[wasm-bindgen]` link definition. Fixes chronotope#1434.
I've opened #1455 - happy to make further wording/... adjustments if needed (or feel free to push to the PR directly if easier) :-) |
edmorley
added a commit
to edmorley/chrono
that referenced
this issue
Feb 23, 2024
The `chrono` crate makes use of several Cargo features: https://github.com/chronotope/chrono/blob/02c68d69a1ff8e6461384a770b87737b5096eae3/Cargo.toml#L19-L46 These features are documented in both `README.md` and the rustdocs in `lib.rs, however, the lists in each place were missing some features and also inconsistent in their descriptions. I've also removed the unused `[wasm-bindgen]` link definition. Fixes chronotope#1434.
edmorley
added a commit
to edmorley/chrono
that referenced
this issue
Feb 23, 2024
The `chrono` crate makes use of several Cargo features: https://github.com/chronotope/chrono/blob/02c68d69a1ff8e6461384a770b87737b5096eae3/Cargo.toml#L19-L46 These features are documented in both `README.md` and the rustdocs in `lib.rs, however, the lists in each place were missing some features and also inconsistent in their descriptions. I've also removed the unused `[wasm-bindgen]` link definition. Fixes chronotope#1434.
pitdicker
pushed a commit
that referenced
this issue
Feb 26, 2024
The `chrono` crate makes use of several Cargo features: https://github.com/chronotope/chrono/blob/02c68d69a1ff8e6461384a770b87737b5096eae3/Cargo.toml#L19-L46 These features are documented in both `README.md` and the rustdocs in `lib.rs, however, the lists in each place were missing some features and also inconsistent in their descriptions. I've also removed the unused `[wasm-bindgen]` link definition. Fixes #1434.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
PR #1343 added a new
now
feature, however, this feature is only documented inREADME.md
and not in the features list ondocs.rs
.Compare README.md:
chrono/README.md
Lines 49 to 67 in 3016c30
With the crate rustdocs:
chrono/src/lib.rs
Lines 20 to 44 in 3016c30
I see there are also some differences in the other features listed under "optional features" too.
The text was updated successfully, but these errors were encountered: