Skip to content

Commit ccb3f67

Browse files
Improve annotation of some function arguments (#106)
2 parents 0981c7e + 50ac2c6 commit ccb3f67

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

src/chart/boxwhisker.typ

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
/// q2: 35, // Median
4545
/// q3: 50) // Upper
4646
/// ```
47-
/// - size (array) : Size of chart. If the second entry is auto, it automatically scales to accommodate the number of entries plotted
47+
/// - size (array): Size of chart. If the second entry is auto, it automatically scales to accommodate the number of entries plotted
4848
/// - label-key (integer, string): Index in the array where labels of each entry is stored
4949
/// - mark (string): Mark to use for plotting outliers. Set `none` to disable. Defaults to "x"
5050
/// - ..plot-args (any): Additional arguments are passed to `plot.plot`

src/plot/bar.typ

+3-3
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,12 @@
143143
/// - data (array): Array of data items. An item is an array containing a x an one or more y values.
144144
/// For example `(0, 1)` or `(0, 10, 5, 30)`. Depending on the `mode`, the data items
145145
/// get drawn as either clustered or stacked rects.
146-
/// - x-key: (int,string): Key to use for retrieving a bars x-value from a single data entry.
146+
/// - x-key (int,string): Key to use for retrieving a bars x-value from a single data entry.
147147
/// This value gets passed to the `.at(...)` function of a data item.
148-
/// - y-key: (auto,int,string,array): Key to use for retrieving a bars y-value. For clustered/stacked
148+
/// - y-key (auto,int,string,array): Key to use for retrieving a bars y-value. For clustered/stacked
149149
/// data, this must be set to a list of keys (e.g. `range(1, 4)`). If set to `auto`, att but the first
150150
/// array-values of a data item are used as y-values.
151-
/// - error-key: (none,int,string,array): Key(s) to use for retrieving a bars y-error.
151+
/// - error-key (none,int,string,array): Key(s) to use for retrieving a bars y-error.
152152
/// - mode (string): The mode on how to group data items into bars:
153153
/// / basic: Add one bar per data value. If the data contains multiple values,
154154
/// group those bars next to each other.

src/plot/errorbar.typ

+6-6
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@
5959
/// Add x- and/or y-error bars
6060
///
6161
/// - pt (tuple): Error-bar center coordinate tuple: `(x, y)`
62-
/// - x-error: (float,tuple): Single error or tuple of errors along the x-axis
63-
/// - y-error: (float,tuple): Single error or tuple of errors along the y-axis
64-
/// - mark: (none,string): Mark symbol to show at the error position (`pt`).
65-
/// - mark-size: (number): Size of the mark symbol.
66-
/// - mark-style: (style): Extra style to apply to the mark symbol.
62+
/// - x-error (float,tuple): Single error or tuple of errors along the x-axis
63+
/// - y-error (float,tuple): Single error or tuple of errors along the y-axis
64+
/// - mark (none,string): Mark symbol to show at the error position (`pt`).
65+
/// - mark-size (number): Size of the mark symbol.
66+
/// - mark-style (style): Extra style to apply to the mark symbol.
6767
/// - whisker-size (float): Width of the error bar whiskers in canvas units.
6868
/// - style (dictionary): Style for the error bars
69-
/// - label: (none,content): Label to tsh
69+
/// - label (none,content): Label to tsh
7070
/// - axes (axes): Plot axes. To draw a horizontal growing bar chart, you can swap the x and y axes.
7171
#let add-errorbar(pt,
7272
x-error: 0,

src/plot/legend.typ

+3-3
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@
9393
/// - label (none, auto, content): Legend label or auto to use the enumerated default label
9494
/// - preview (auto, function): Legend preview icon function of the format `item => elements`.
9595
/// Note that the canvas bounds for drawing the preview are (0,0) to (1,1).
96-
/// - mark: (none,string): Legend mark symbol
97-
/// - mark-style: (none,dictionary): Mark style
98-
/// - mark-size: (number): Mark size
96+
/// - mark (none,string): Legend mark symbol
97+
/// - mark-style (none,dictionary): Mark style
98+
/// - mark-size (number): Mark size
9999
/// - ..style (styles): Style keys for the single item
100100
#let item(label, preview, mark: none, mark-style: (:), mark-size: 1, ..style) = {
101101
assert.eq(style.pos().len(), 0,

0 commit comments

Comments
 (0)