Skip to content

Commit 1c74585

Browse files
committed
more doc
1 parent d800af0 commit 1c74585

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

src/coord/ranged1d/mod.rs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,21 @@ impl KeyPointHint for LightPoints {
175175
}
176176

177177
/// The trait that indicates we have a ordered and ranged value
178-
/// Which is used to describe the axis
178+
/// Which is used to describe any 1D axis.
179179
pub trait Ranged {
180+
/// This marker decides if Plotters default [ValueFormatter](trait.ValueFormatter.html) implementation should be used.
181+
/// This assicated type can be one of follow two types:
182+
/// - [DefaultFormatting](struct.DefaultFormatting.html) will allow Plotters automatically impl
183+
/// the formatter based on `Debug` trait, if `Debug` trait is not impl for the `Self::Value`,
184+
/// [ValueFormatter](trait.ValueFormatter.html) will not impl unless you impl it manually.
185+
///
186+
/// - [NoDefaultFormatting](struct.NoDefaultFormatting.html) Disable the automatical `Debug`
187+
/// based value formatting. Thus you have to impl the
188+
/// [ValueFormatter](trait.ValueFormatter.html) manually.
189+
///
180190
type FormatOption: DefaultValueFormatOption;
181191

182-
/// The type of this value
192+
/// The type of this value in this range specification
183193
type ValueType;
184194

185195
/// This function maps the value to i32, which is the drawing coordinate

0 commit comments

Comments
 (0)