Skip to content

Commit f2612e9

Browse files
committed
Improve color docs
1 parent 76029b4 commit f2612e9

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

gnuplot/src/color.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ pub enum ColorType<T = String>
7979
/// Comparing with [PaletteCBColor]: given the following code
8080
/// ```
8181
/// use gnuplot::{PaletteCBColor, PaletteFracColor, Fix, Figure, AxesCommon, Color};
82-
/// let min = -5.0; // or any value
83-
/// let max = 12.0; // or any value
82+
///# let min = -5.0; // or any value
83+
///# let max = 12.0; // or any value
8484
///
85-
/// let frac = 0.5; // or any value 0.0 <= frac <= 1.0
85+
///# let frac = 0.5; // or any value 0.0 <= frac <= 1.0
8686
/// assert!(frac >= 0.0);
8787
/// assert!(frac <= 1.0);
8888
///
@@ -93,7 +93,7 @@ pub enum ColorType<T = String>
9393
/// let cb_range = max - min;
9494
/// let col2 = Color(PaletteCBColor(min + (frac * cb_range)));
9595
/// ```
96-
/// `col1` and `col2` should give the same color.
96+
/// `col1` and `col2` should give the same color for any values of `max` and `min`, and `0 <= frac <= 1`.
9797
PaletteCBColor(f64),
9898
/// Vector of `f64` values which act as indexes into the current palette to set the color of
9999
/// each data point. These variable values work in the same was as the single fixed value supplied
@@ -102,7 +102,7 @@ pub enum ColorType<T = String>
102102
/// Similar to `VariablePaletteColor` in that it takes a `Vec<f64>` to set the indexes into the
103103
/// color map for each data point, but in addition to the color data it takes a string hold the name
104104
/// of the color map to use. This should have been previously created in the workspace using the
105-
/// (create_colormap())[crate::AxesCommon::create_colormap()] function.
105+
/// [create_colormap()](crate::AxesCommon::create_colormap) function.
106106
SavedColorMap(T, Vec<f64>),
107107
/// Set the color of all elements of the plot to the `n`th color in the current gnuplot color cycle.
108108
Index(ColorIndex),

0 commit comments

Comments
 (0)