Improve docs for crate features

[edmorley]

The chrono crate makes use of several Cargo features:

chrono/Cargo.toml

Lines 19 to 46 in 02c68d6

	[features]
	# Don't forget to adjust `ALL_NON_EXCLUSIVE_FEATURES` in CI scripts when adding a feature or an optional dependency.
	default = ["clock", "std", "oldtime", "wasmbind"]
	alloc = []
	libc = []
	winapi = ["windows-targets"]
	std = ["alloc"]
	clock = ["winapi", "iana-time-zone", "android-tzdata", "now"]
	now = ["std"]
	oldtime = []
	wasmbind = ["wasm-bindgen", "js-sys"]
	unstable-locales = ["pure-rust-locales"]
	# Note that rkyv-16, rkyv-32, and rkyv-64 are mutually exclusive.
	rkyv = ["dep:rkyv", "rkyv/size_32"]
	rkyv-16 = ["dep:rkyv", "rkyv?/size_16"]
	rkyv-32 = ["dep:rkyv", "rkyv?/size_32"]
	rkyv-64 = ["dep:rkyv", "rkyv?/size_64"]
	rkyv-validation = ["rkyv?/validation"]
	# Features for internal use only:
	__internal_bench = []
	[dependencies]
	num-traits = { version = "0.2", default-features = false }
	rustc-serialize = { version = "0.3.20", optional = true }
	serde = { version = "1.0.99", default-features = false, optional = true }
	pure-rust-locales = { version = "0.8", optional = true }
	rkyv = { version = "0.7.43", optional = true, default-features = false }
	arbitrary = { version = "1.0.0", features = ["derive"], optional = true }

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.11%. Comparing base (02c68d6) to head (ed6fb25).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1455   +/-   ##
=======================================
  Coverage   92.11%   92.11%           
=======================================
  Files          40       40           
  Lines       18026    18026           
=======================================
  Hits        16604    16604           
  Misses       1422     1422           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[pitdicker]

Thank you @edmorley for straightening this out. One nit and one suggestion.

[pitdicker]

Now that everything starts with a capital, update this line also?

[edmorley]

Good spot - I had skim read to look for more capitalisation issues, but my eyes clearly failed me 😆

[pitdicker]

We should probably discourage the use of this feature in the documentation, we only have it for compatibility. The replacement features where introduced in #1368.
No preference from my side on how to word it. Maybe just "rkyv: Deprecated, use the kkyv-* features"?

[edmorley]

Sounds good to me!

[edmorley]

I've force pushed rather than adding a "Fix review comments" commit since it looks like this repo doesn't normally use squash merges. To make the re-review easier, the diff between this version and the last can be seen here:
https://github.com/chronotope/chrono/compare/88eaa06ee4b8b5551efaceceaf62d7a5227eb0fd..1ca1df1654755f01402c5986802169802a1c7f3c

[pitdicker]

Thank you!
And thanks for looking at how we like the commits 😄.

@djc will probably also want to have a look.

[djc]

Thanks for cleaning this up!

Consistency is good, but on balance I would probably prefer to avoid capitalizing after :.

[edmorley]

Consistency is good, but on balance I would probably prefer to avoid capitalizing after :.

So I tried switching to using lowercase after the colons, however, that didn't work so well for the items in the list that have multiple sentences after the colon, since then the first sentence is not capitalised, but later ones are.

Searching around, it seems that it's acceptable to capitalise after a colon when using a complete sentence:
https://www.grammarly.com/blog/capitalization-after-colons/

As such, I've added a couple of missing trailing periods, making all entries be complete sentences, so that they are suitable for capitalisation.

[edmorley]

I've force pushed with the latest changes; diff here:
https://github.com/chronotope/chrono/compare/1ca1df1654755f01402c5986802169802a1c7f3c..ed6fb2592f66f497169ed9bb322d2c5e6e51643d

[pitdicker]

Thank you @edmorley.