Skip to content

Commit f4c8de0

Browse files
authored
docs(chart): document chart module (#696)
1 parent 910ad00 commit f4c8de0

File tree

2 files changed

+341
-54
lines changed

2 files changed

+341
-54
lines changed

src/symbols.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -398,12 +398,12 @@ pub mod braille {
398398
/// Marker to use when plotting data points
399399
#[derive(Debug, Default, Display, EnumString, Clone, Copy, Eq, PartialEq, Hash)]
400400
pub enum Marker {
401-
/// One point per cell in shape of dot ("•")
401+
/// One point per cell in shape of dot (`•`)
402402
#[default]
403403
Dot,
404-
/// One point per cell in shape of a block ("█")
404+
/// One point per cell in shape of a block (`█`)
405405
Block,
406-
/// One point per cell in the shape of a bar ("▄")
406+
/// One point per cell in the shape of a bar (`▄`)
407407
Bar,
408408
/// Use the [Unicode Braille Patterns](https://en.wikipedia.org/wiki/Braille_Patterns) block to
409409
/// represent data points.
@@ -412,9 +412,9 @@ pub enum Marker {
412412
///
413413
/// Note: Support for this marker is limited to terminals and fonts that support Unicode
414414
/// Braille Patterns. If your terminal does not support this, you will see unicode replacement
415-
/// characters () instead of Braille dots.
415+
/// characters (`�`) instead of Braille dots (`⠓`, `⣇`, `⣿`).
416416
Braille,
417-
/// Use the unicode block and half block characters ("█", "▄", and "▀") to represent points in
417+
/// Use the unicode block and half block characters (`█`, `▄`, and `▀`) to represent points in
418418
/// a grid that is double the resolution of the terminal. Because each terminal cell is
419419
/// generally about twice as tall as it is wide, this allows for a square grid of pixels.
420420
HalfBlock,

0 commit comments

Comments
 (0)