Conversation
|
Hi, thanks for taking the time to do this! I should have done something similar long ago but it slipped my mind. As much as I appreciate the help and effort, I would like the wording and grouping to match the readme and for it to be part of a "getting started" section up top. If you look at what I did for Second, please don't change the feature set, even though some may seem useless. It's a breaking change after all and potentially unnecessary churn. Also please follow the template for closed issues. Those keywords will close the issue automatically, and I'm also using a script for reading them when generating the release notes. Oh and ignore the miri error, it's just fallout from floating point number randomization they added to emulate platform differences. I just got to relax the precision requirement in that test. |
|
The miri error should hopefully be fixed now if you rebase this on top of master. |
9a062d4 to
084eb35
Compare
Move the feature documentation into the crate-level getting started section, match the README wording and grouping, and clarify the `libm` requirement for `no_std` builds.
084eb35 to
caa8a92
Compare
|
Ah, great! Thank you! |

Summary
palette/README.mdCargo.tomlWhy
This follows the same documentation pattern used by
palette_math, where the crate docs and READMEcan be edited in tandem without introducing another source of truth for feature descriptions.
Closes #415.
Validation
cargo +nightly docs-rs -p palette