Skip to content

Commit

Permalink
Merge pull request #402 from waywardmonkeys/fix-clippy-doc-lazy-conti…
Browse files Browse the repository at this point in the history
…nuation-lints

Fix `clippy::doc_lazy_continuation` lints
  • Loading branch information
Ogeon authored Jul 30, 2024
2 parents 8550250 + 08ea298 commit 28307cc
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 27 deletions.
20 changes: 10 additions & 10 deletions palette/src/convert.rs
Original file line number Diff line number Diff line change
Expand Up @@ -135,24 +135,24 @@
//! ### Item Attributes
//!
//! * `skip_derives(Luma, Rgb)`: No conversion derives will be implemented for
//! these colors. They are instead to be implemented manually, and serve as the
//! basis for the automatic implementations.
//! these colors. They are instead to be implemented manually, and serve as the
//! basis for the automatic implementations.
//!
//! * `white_point = "some::white_point::Type"`: Sets the white point type that
//! should be used when deriving. The default is `D65`, but it may be any other
//! type, including type parameters.
//! should be used when deriving. The default is `D65`, but it may be any other
//! type, including type parameters.
//!
//! * `component = "some::component::Type"`: Sets the color component type that
//! should be used when deriving. The default is `f32`, but it may be any other
//! type, including type parameters.
//! should be used when deriving. The default is `f32`, but it may be any other
//! type, including type parameters.
//!
//! * `rgb_standard = "some::rgb_standard::Type"`: Sets the RGB standard type
//! that should be used when deriving. The default is to either use `Srgb` or a
//! best effort to convert between standards, but sometimes it has to be set to
//! a specific type. This also accepts type parameters.
//! that should be used when deriving. The default is to either use `Srgb` or a
//! best effort to convert between standards, but sometimes it has to be set to
//! a specific type. This also accepts type parameters.
//!
//! * `luma_standard = "some::rgb_standard::Type"`: Sets the Luma standard type
//! that should be used when deriving, similar to `rgb_standard`.
//! that should be used when deriving, similar to `rgb_standard`.
//!
//! ### Field Attributes
//!
Expand Down
26 changes: 13 additions & 13 deletions palette/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,13 @@
//! When working with RGB or gray scale (luma):
//!
//! * If you are asking your user to enter an RGB value, you are in a gray zone
//! where it depends on the context. It's usually safe to assume sRGB, but
//! sometimes it's already linear.
//! where it depends on the context. It's usually safe to assume sRGB, but
//! sometimes it's already linear.
//!
//! * If you are decoding an image, there may be some meta data that gives you
//! the necessary details. Otherwise it's most commonly sRGB. Usually you will
//! end up with a slice or vector with RGB bytes, which can easily be converted
//! to Palette colors:
//! the necessary details. Otherwise it's most commonly sRGB. Usually you will
//! end up with a slice or vector with RGB bytes, which can easily be converted
//! to Palette colors:
//!
//! ```rust
//! # let mut image_buffer: Vec<u8> = vec![];
Expand All @@ -216,20 +216,20 @@
//! ```
//!
//! * If you are getting your colors from the GPU, in a game or other graphical
//! application, or if they are otherwise generated by the application, then
//! chances are that they are already linear. Still, make sure to check that
//! they are not being encoded somewhere.
//! application, or if they are otherwise generated by the application, then
//! chances are that they are already linear. Still, make sure to check that
//! they are not being encoded somewhere.
//!
//! When working with other colors:
//!
//! * For HSL, HSV, HWB: Check if they are based on any other color space than
//! sRGB, such as Adobe or Apple RGB.
//! sRGB, such as Adobe or Apple RGB.
//!
//! * For any of the CIE color spaces, check for a specification of white point
//! and light source. These are necessary for converting to RGB and other
//! colors, that depend on perception and "viewing devices". Common defaults are
//! the D65 light source and the sRGB white point. The Palette defaults should
//! take you far.
//! and light source. These are necessary for converting to RGB and other
//! colors, that depend on perception and "viewing devices". Common defaults are
//! the D65 light source and the sRGB white point. The Palette defaults should
//! take you far.
//!
//! ## 2. Processing
//!
Expand Down
4 changes: 2 additions & 2 deletions palette/src/okhsl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ mod visual_eq;
/// * changing hue/chroma/saturation, while keeping perceived lightness constant (like HSLuv)
/// * changing lightness/chroma/saturation, while keeping perceived hue constant
/// * changing the perceived saturation (more or less) proportionally with the numerical
/// amount of change (unlike HSLuv)
/// amount of change (unlike HSLuv)
#[derive(Debug, Copy, Clone, ArrayCast, FromColorUnclamped, WithAlpha)]
#[cfg_attr(feature = "serializing", derive(Serialize, Deserialize))]
#[palette(
Expand All @@ -57,7 +57,7 @@ pub struct Okhsl<T = f32> {
/// The saturation (freedom of black or white) of the color.
///
/// * `0.0` corresponds to pure mixture of black and white without any color.
/// The black to white relation depends on v.
/// The black to white relation depends on v.
/// * `1.0` to a fully saturated color without any white.
///
/// For v == 0 the saturation is irrelevant.
Expand Down
4 changes: 2 additions & 2 deletions palette/src/okhsv.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ mod visual_eq;
///
/// Allows
/// * changing lightness/chroma/saturation while keeping perceived Hue constant
/// (like HSV promises but delivers only partially)
/// (like HSV promises but delivers only partially)
/// * finding the strongest color (maximum chroma) at s == 1 (like HSV)
#[derive(Debug, Copy, Clone, ArrayCast, FromColorUnclamped, WithAlpha)]
#[cfg_attr(feature = "serializing", derive(Serialize, Deserialize))]
Expand All @@ -60,7 +60,7 @@ pub struct Okhsv<T = f32> {
/// The saturation (freedom of whitishness) of the color.
///
/// * `0.0` corresponds to pure mixture of black and white without any color.
/// The black to white relation depends on v.
/// The black to white relation depends on v.
/// * `1.0` to a fully saturated color without any white.
///
/// For v == 0 the saturation is irrelevant.
Expand Down

0 comments on commit 28307cc

Please sign in to comment.