Skip to content

Commit

Permalink
Improve document linking
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys committed Dec 21, 2024
1 parent e203342 commit 572afeb
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
3 changes: 2 additions & 1 deletion color/src/dynamic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use crate::{
};
use core::hash::{Hash, Hasher};

/// A color with a color space tag decided at runtime.
/// A color with a [color space tag] decided at runtime.
///
/// This type is roughly equivalent to [`AlphaColor`] except with a tag
/// for color space as opposed being determined at compile time. It can
Expand All @@ -27,6 +27,7 @@ use core::hash::{Hash, Hasher};
/// When manipulating components directly, setting them nonzero when the
/// corresponding missing flag is set may yield unexpected results.
///
/// [color space tag]: ColorSpaceTag
/// [Oklch]: crate::Oklch
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
Expand Down
2 changes: 1 addition & 1 deletion color/src/gradient.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use crate::{
/// This will yield a value for each gradient stop, including `t` values
/// of 0 and 1 at the endpoints.
///
/// Use the `gradient` function to generate this iterator.
/// Use the [`gradient`] function to generate this iterator.
#[expect(missing_debug_implementations, reason = "it's an iterator")]
pub struct GradientIter<CS: ColorSpace> {
interpolator: Interpolator,
Expand Down
4 changes: 3 additions & 1 deletion color/src/tag.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use crate::{
Missing, Oklab, Oklch, ProphotoRgb, Rec2020, Srgb, XyzD50, XyzD65,
};

/// The color space tag for dynamic colors.
/// The color space tag for [dynamic colors].
///
/// This represents a fixed set of known color spaces. The set is
/// based on the CSS Color 4 spec, but might also extend to a small
Expand All @@ -17,6 +17,8 @@ use crate::{
/// Note: this has some tags not yet implemented.
///
/// Note: when adding an RGB-like color space, add to `same_analogous`.
///
/// [dynamic colors]: crate::DynamicColor
#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[non_exhaustive]
Expand Down

0 comments on commit 572afeb

Please sign in to comment.