Add doc alias, doc cleanups, remove trait from Packed struct #216
Conversation
Add "hsb" alias for Hsv Add "linear" for LinLuma/a and LinSrgb/a Add "wcag" for RelativeContrast trait Add "xyY" for Yxy Add "gray/grey" for Luma Make rgb::FromHexError public and document it Clean up document example in RelativeContrast Remove RgbChannels trait from Packed struct
|
I added a few doc aliases that seemed appropriate and did some small fixups in docs. The aliases make searching a bit more ergonomic. The search is surprisingly fuzzy but also doesn't surface as much as I'd probably want based on the documentation text. I know people can tend to copy/paste code straight from docs so I wanted to change the relative contrast example to show |
| /// let unpacked: Srgba<u8> = Packed::<Rgba>::from(0xFFFF_FF80).into(); | ||
| /// assert_relative_eq!( | ||
| /// Srgba::new(0.5, 1.0, 1.0, 0.5), | ||
| /// Srgba::new(1.0, 1.0, 1.0, 0.5), |
There was a problem hiding this comment.
I just want to say that I appreciate that you spotted this. Nice to remove the ambiguity!
|
This is a good set of aliases and some nice cleanup! Thank you! bors r+ |
|
Build succeeded: |
Add "hsb" alias for Hsv
Add "linear" for LinLuma/a and LinSrgb/a
Add "wcag" for RelativeContrast trait
Add "xyY" for Yxy
Add "gray/grey" for Luma
Make rgb::FromHexError public and document it
Clean up document example in RelativeContrast
Remove RgbChannels trait from Packed struct