From 33a7f0f1bd75a618e4d4f7dbcaef5431b6693796 Mon Sep 17 00:00:00 2001 From: Robert Grimm Date: Fri, 12 Jul 2024 04:21:02 -0400 Subject: [PATCH] improve summary descriptions of prettypretty's abstractions --- src/core/difference.rs | 3 ++- src/term_color.rs | 2 +- src/translation.rs | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/src/core/difference.rs b/src/core/difference.rs index fcf1439..c665131 100644 --- a/src/core/difference.rs +++ b/src/core/difference.rs @@ -103,7 +103,8 @@ fn prepare_coordinate_interpolation( intermediate } -/// A strategy for interpolating hues. +/// A strategy for interpolating hues used by +/// [`Color::interpolate`](crate::Color::interpolate). /// /// Since hues are expressed as angles, the same perceptual hue has an infinite /// number of representations modulo 360. Furthermore, there are two ways of diff --git a/src/term_color.rs b/src/term_color.rs index 00b6a7b..8696cee 100644 --- a/src/term_color.rs +++ b/src/term_color.rs @@ -1145,7 +1145,7 @@ impl TryFrom for Color { // ==================================================================================================================== // Layer and Fidelity -/// The layer for rendering to the terminal: Foreground or background. +/// The targeted display layer: Foreground or background. #[cfg_attr(feature = "pyffi", pyclass(eq, eq_int, frozen, hash))] #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] pub enum Layer { diff --git a/src/translation.rs b/src/translation.rs index c483379..01c7983 100644 --- a/src/translation.rs +++ b/src/translation.rs @@ -80,7 +80,7 @@ impl TryFrom for ThemeEntry { } } -/// An iterator over theme entries. +/// A helper for iterating over the slot names of theme entries. /// /// This iterator is fused, i.e., after returning `None` once, it will keep /// returning `None`. This iterator also is exact, i.e., its `size_hint()`