Skip to content

Commit

Permalink
plot: Improve tick documentation (#269)
Browse files Browse the repository at this point in the history
Improve documentation a bit.
  • Loading branch information
johannes-wolf authored Oct 23, 2023
1 parent 6e59daa commit 19c65b1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/lib/plot.typ
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@
///
/// The following options are supported per axis
/// and must be prefixed by `<axis-name>-`, e.G.
/// `x-min: 0`.
/// `x-min: 0` or `y-label: [y]`.
/// #box[
/// - label (content): Axis label
/// - min (int): Axis minimum value
/// - max (int): Axis maximum value
/// - tick-step (float): Distance between major ticks
/// - minor-tick-step (float): Distance between minor ticks
/// - tick-step (none, float): Distance between major ticks (or no ticks if none)
/// - minor-tick-step (none, float): Distance between minor ticks (or no ticks if none)
/// - ticks (array): List of ticks values or value/label
/// tuples. Example `(1,2,3)` or `((1, [A]), (2, [B]),)`
/// - format (string): Tick label format, `"float"`, `"sci"` (scientific)
Expand All @@ -71,7 +71,7 @@
/// - `"minor"`: Enable minor tick grid
/// - `"both"`: Enable major & minor tick grid
/// - `false`: Disable grid
/// - unit (content): Tick label suffix
/// - unit (none, content): Tick label suffix
/// - decimals (int): Number of decimals digits to display for tick labels
/// ]
///
Expand Down

0 comments on commit 19c65b1

Please sign in to comment.