manual: Fix the manual + Update Tidy

johannes-wolf · johannes-wolf · commit 03fb26fb4b8f · 2025-06-10T10:40:50.000+02:00
diff --git a/common b/common
@@ -1 +1 @@
-Subproject commit 79d90ca3dd48e4b192704734e432fe04502e4a78
+Subproject commit fa1d1181f45609edf85b9632c18ce950fe87d048
diff --git a/doc/example.typ b/doc/example.typ
@@ -21,9 +21,9 @@
   let canvas-background = yellow.lighten(95%)
 
   let picture = cetz.canvas(
-    eval(
+    std.eval(
       example-preamble + source,
-      scope: example-scope
+      scope: example-scope,
     ),
     ..args
   )
diff --git a/doc/style.typ b/doc/style.typ
@@ -1,7 +1,6 @@
-#import "example.typ": example
 #import "/src/lib.typ"
 
-#import "@preview/tidy:0.3.0"
+#import "@preview/tidy:0.4.3"
 #import "@preview/t4t:0.3.2": is
 
 #let show-function(fn, style-args) = {
@@ -84,11 +83,11 @@
     tidy.parse-module(
       read(path),
       scope: (
-        example: example,
         show-parameter-block: show-parameter-block,
         cetz: lib
       )
     ),
+    first-heading-level: 1,
     show-outline: false,
     sort-functions: none,
   )
diff --git a/gallery/cycles.png b/gallery/cycles.png
diff --git a/manual.pdf b/manual.pdf
diff --git a/manual.typ b/manual.typ
@@ -3,15 +3,18 @@
 #import "/doc/example.typ": example
 #import "/doc/style.typ" as doc-style
 #import "/src/lib.typ": *
-#import "@preview/tidy:0.3.0"
+#import "@preview/tidy:0.4.3"
 
 
 // Usage:
-//   ```example
+//   ```cexample
 //   /* canvas drawing code */
 //   ```
-#show raw.where(lang: "example"): example
-#show raw.where(lang: "example-vertical"): example.with(vertical: true)
+//
+//   Why cexample? Because tidy thinks it has to mess
+//   with each raw block...
+#show raw.where(lang: "cexample"): example
+#show raw.where(lang: "cexample-vertical"): example.with(vertical: true)
 
 #make-title()
 
@@ -64,7 +67,7 @@ You can use style root `axes` with the following keys:
 #doc-style.parse-show-module("/src/axes.typ")
 
 === Example
-```example
+```cexample
 import cetz.draw: *
 import cetz-plot: *
 
diff --git a/src/chart/barchart.typ b/src/chart/barchart.typ
@@ -16,7 +16,7 @@
 /// rectangular bars that grow from left to right, proportional to the values
 /// they represent.
 ///
-/// = Styling
+/// === Styling
 /// Can be applied with `cetz.draw.set-style(barchart: (bar-width: 1))`.
 ///
 /// *Root*: `barchart`.
diff --git a/src/chart/boxwhisker.typ b/src/chart/boxwhisker.typ
@@ -11,14 +11,14 @@
 
 /// Add one or more box or whisker plots.
 ///
-/// #example(```
+/// ```cexample
 /// chart.boxwhisker(size: (2,2), label-key: none,
 ///   y-min: 0, y-max: 70, y-tick-step: 20,
 ///   (x: 1, min: 15, max: 60,
 ///    q1: 25, q2: 35, q3: 50))
-/// ```)
+/// ```
 ///
-/// = Styling
+/// === Styling
 /// *Root* `boxwhisker`
 /// #show-parameter-block("box-width", "float", default: .75, [
 ///   The width of the box. Since boxes are placed 1 unit next to each other,
diff --git a/src/chart/columnchart.typ b/src/chart/columnchart.typ
@@ -16,7 +16,7 @@
 /// rectangular bars that grow from bottom to top, proportional to the values
 /// they represent.
 ///
-/// = Styling
+/// === Styling
 /// *Root*: `columnchart`.
 /// #show-parameter-block("bar-width", "float", default: .8, [
 ///   Width of a single bar (basic) or a cluster of bars (clustered) in the plot.])
diff --git a/src/chart/piechart.typ b/src/chart/piechart.typ
@@ -89,7 +89,7 @@
 
 /// Draw a pie- or donut-chart
 ///
-/// #example(```
+/// ```cexample
 /// let data = (24, 31, 18, 21, 23, 18, 27, 17, 26, 13)
 /// let colors = gradient.linear(red, blue, green, yellow)
 ///
@@ -99,9 +99,9 @@
 ///   slice-style: colors,
 ///   inner-radius: .5,
 ///   outer-label: (content: "%",))
-/// ```)
+/// ```
 ///
-/// = Styling
+/// === Styling
 /// *Root* `piechart` \
 /// #show-parameter-block("radius", ("number"), [
 ///   Outer radius of the chart.], default: 1)
@@ -157,7 +157,7 @@
 /// #show-parameter-block("legend.label", ("none","string","function"), [
 ///   See `outer-label.content`. The legend gets shown if this key is set != none.], default: "LABEL")
 ///
-/// = Anchors
+/// === Anchors
 ///   The chart places one anchor per item at the radius of it's slice that
 ///   gets named `"item-<index>"` (outer radius) and `"item-<index>-inner"` (inner radius),
 ///   where index is the index of the sclice data in `data`.
diff --git a/src/chart/pyramid.typ b/src/chart/pyramid.typ
@@ -36,7 +36,7 @@
 
 /// Draw a pyramid chart
 ///
-/// #example(```
+/// ```cexample
 /// let data = (
 ///   "transcendence",
 ///   "self-actualization",
@@ -58,9 +58,9 @@
 ///   data,
 ///   level-style: colors,
 ///   level-height: 0.7)
-/// ```)
+/// ```
 ///
-/// = Styling
+/// === Styling
 /// *Root* `pyramid` \
 /// #show-parameter-block("level-height", ("number"), [
 ///   Minimum level height.], default: 1)
@@ -90,7 +90,7 @@
 /// #show-parameter-block("inner-label.force-inside", ("boolean"), [
 ///   If false, labels are automatically placed outside their correspoding levels if they don't fit inside. If true, they are always placed inside.], default: false)
 ///
-/// = Anchors
+/// === Anchors
 ///   The chart places one anchor per item at the center of its level that
 ///   gets named `"levels.<index>"`, one on the middle of its left side named `"levels.<index>.west"`, and one on the right side named `"levels.<index>.east"`,
 ///   where index is the index of the level data in `data`.
diff --git a/src/lib.typ b/src/lib.typ
@@ -1,4 +1,4 @@
-#let version = version(0,1,1)
+#let version = version(0,1,2)
 
 #import "/src/axes.typ"
 #import "/src/plot.typ"
diff --git a/src/plot.typ b/src/plot.typ
@@ -32,18 +32,16 @@
 /// `plot.add` or other plotting functions. The plot environment supports different
 /// axis styles to draw, see its parameter `axis-style:`.
 ///
-/// #example(```
+/// ```cexample
 /// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
 ///   plot.add(((0,0), (1,1), (2,.5), (4,3)))
 /// })
-/// ```)
+/// ```
 ///
 /// To draw elements insides a plot, using the plots coordinate system, use
 /// the `plot.annotate(..)` function.
 ///
-/// = parameters
-///
-/// = Options
+/// === Options
 ///
 /// You can use the following options to customize each axis of the plot. You must pass them as named arguments prefixed by the axis name followed by a dash (`-`) they should target. Example: `x-min: 0`, `y-ticks: (..)` or `x2-label: [..]`.
 ///
@@ -58,14 +56,14 @@
 ///   depending on the other axis orientation (see `horizontal`).
 ///   This can be useful to force one axis to grow or shrink with another one.
 ///   You can only "lock" two axes of different orientations.
-///   #example(```
+///   ```cexample
 ///   plot.plot(size: (2,1), x-tick-step: 1, y-tick-step: 1,
 ///             x-equal: "y",
 ///   {
 ///     plot.add(domain: (0, 2 * calc.pi),
 ///       t => (calc.cos(t), calc.sin(t)))
 ///   })
-///   ```)
+///   ```
 /// ])
 /// #show-parameter-block("horizontal", ("bool"), default: "axis name dependant", [
 ///   If true, the axis is considered an axis that gets drawn horizontally, vertically otherwise.
@@ -83,7 +81,7 @@
 ///   an array of `<float>` values or an array of `(<float>, <content>)` tuples for
 ///   setting custom tick mark labels per mark.
 ///
-///   #example(```
+///   ```cexample
 ///   plot.plot(x-tick-step: none, y-tick-step: none,
 ///             x-min: 0, x-max: 4,
 ///             x-ticks: (1, 2, 3),
@@ -92,7 +90,7 @@
 ///   {
 ///     plot.add(((0,0),))
 ///   })
-///   ```)
+///   ```
 ///
 ///   Examples: `(1, 2, 3)` or `((1, [One]), (2, [Two]), (3, [Three]))`])
 /// #show-parameter-block("format", ("none", "string", "function"), default: "float", [
@@ -101,15 +99,15 @@
 ///   / float: Floating point formatting rounded to two digits after the point (see `decimals`)
 ///   / sci: Scientific formatting with $times 10^n$ used as exponet syntax
 ///
-///   #example(```
+///   ```cexample
 ///   let formatter(v) = if v != 0 {$ #{v/calc.pi} pi $} else {$ 0 $}
 ///   plot.plot(x-tick-step: calc.pi, y-tick-step: none,
 ///             x-min: 0, x-max: 2 * calc.pi,
 ///             x-format: formatter,
 ///   {
 ///     plot.add(((0,0),))
 ///   })
-///   ```)
+///   ```
 /// ])
 /// #show-parameter-block("decimals", ("int"), default: "2", [
 ///   Number of decimals digits to display for tick labels, if the format is set
@@ -125,14 +123,14 @@
 ///   to `"minor"`, show grid lines for minor ticks only.
 ///   The value `"both"` enables grid lines for both, major- and minor ticks.
 ///
-///   #example(```
+///   ```cexample
 ///   plot.plot(x-tick-step: 1, y-tick-step: 1,
 ///             y-minor-tick-step: .2,
 ///             x-min: 0, x-max: 2, x-grid: true,
 ///             y-min: 0, y-max: 2, y-grid: "both", {
 ///     plot.add(((0,0),))
 ///   })
-///   ```)
+///   ```
 /// ])
 /// #show-parameter-block("break", ("bool"), default: "false", [
 ///   If true, add a "sawtooth" at the start or end of the axis line, depending
@@ -155,7 +153,7 @@
 ///               and the x axis at the bottom (at `y.min`)
 ///   / `none`: Draw no axes (and no ticks).
 ///
-///   #example(```
+///   ```cexample-vertical
 ///   let opts = (x-tick-step: none, y-tick-step: none, size: (2,1))
 ///   let data = plot.add(((-1,-1), (1,1),), mark: "o")
 ///
@@ -164,7 +162,7 @@
 ///     content(((0,-1), "-|", "plot.south"), repr(name))
 ///     set-origin((3.5,0))
 ///   }
-///   ```, vertical: true)
+///   ```
 /// - plot-style (style,function): Styling to use for drawing plot graphs.
 ///   This style gets inherited by all plots and supports `palette` functions.
 ///   The following style keys are supported:
@@ -526,7 +524,7 @@
 /// This function is similar to `draw.anchor` but it takes an additional
 /// axis tuple to specify which axis coordinate system to use.
 ///
-/// #example(```
+/// ```cexample
 /// plot.plot(size: (2,2), name: "plot",
 ///           x-tick-step: none, y-tick-step: none, {
 ///   plot.add(((0,0), (1,1), (2,.5), (4,3)))
@@ -535,7 +533,7 @@
 ///
 /// line("plot.pt", ((), "|-", (0,1.5)), mark: (start: ">"), name: "line")
 /// content("line.end", [Here], anchor: "south", padding: .1)
-/// ```)
+/// ```
 ///
 /// - name (string): Anchor name
 /// - position (tuple): Tuple of x and y values.
diff --git a/src/plot/annotation.typ b/src/plot/annotation.typ
@@ -8,15 +8,15 @@
 /// An annotation is a sub-canvas that uses the plots coordinates specified
 /// by its x and y axis.
 ///
-/// #example(```
+/// ```cexample
 /// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
 ///   plot.add(domain: (0, 2*calc.pi), calc.sin)
 ///   plot.annotate({
 ///     rect((0, -1), (calc.pi, 1), fill: rgb(50,50,200,50))
 ///     content((calc.pi, 0), [Here])
 ///   })
 /// })
-/// ```)
+/// ```
 ///
 /// Bounds calculation is done naively, therefore fixed size content _can_ grow
 /// out of the plot. You can adjust the padding manually to adjust for that. The
diff --git a/src/plot/boxwhisker.typ b/src/plot/boxwhisker.typ
@@ -2,7 +2,7 @@
 
 /// Add one or more box or whisker plots
 ///
-/// #example(```
+/// ```cexample
 /// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
 ///   plot.add-boxwhisker((x: 1, // Location on x-axis
 ///     outliers: (7, 65, 69),        // Optional outlier values
@@ -11,7 +11,7 @@
 ///     q2: 35,                       //            Median
 ///     q3: 50))                      //            Upper
 /// })
-/// ```)
+/// ```
 ///
 /// - data (array, dictionary): dictionary or array of dictionaries containing the
 ///   needed entries to plot box and whisker plot.
diff --git a/src/plot/contour.typ b/src/plot/contour.typ
@@ -241,7 +241,7 @@
 
 /// Add a contour plot of a sampled function or a matrix.
 ///
-/// #example(```
+/// ```cexample
 /// plot.plot(size: (2,2), x-tick-step: none, y-tick-step: none, {
 ///   plot.add-contour(x-domain: (-3, 3), y-domain: (-3, 3),
 ///     style: (fill: rgb(50,50,250,50)),
@@ -250,7 +250,7 @@
 ///     z: (2.5, 2, 1), // Z values to find contours for
 ///     (x, y) => calc.sqrt(x * x + y * y))
 /// })
-/// ```)
+/// ```
 ///
 /// - data (array, function): A function of the signature `(x, y) => z`
 ///   or an array of arrays of floats (a matrix) where the first
diff --git a/src/plot/formats.typ b/src/plot/formats.typ
@@ -40,7 +40,7 @@
 
 /// Fraction tick formatter
 ///
-/// ```example
+/// ```cexample
 /// plot.plot(size: (5,1),
 ///           x-format: plot.formats.fraction,
 ///           x-tick-step: 1/5,
@@ -61,7 +61,7 @@
 
 /// Multiple of tick formatter
 ///
-/// ```example
+/// ```cexample
 /// plot.plot(size: (5,1),
 ///           x-format: plot.formats.multiple-of,
 ///           x-tick-step: calc.pi/4,
@@ -107,7 +107,7 @@
 
 /// Scientific notation tick formatter
 ///
-/// ```example
+/// ```cexample
 /// plot.plot(size: (5,1),
 ///           x-format: plot.formats.sci,
 ///           x-tick-step: 1e3,
@@ -145,7 +145,7 @@
 
 /// Rounded decimal number formatter
 ///
-/// ```example
+/// ```cexample
 /// plot.plot(size: (5,1),
 ///           x-format: plot.formats.decimal,
 ///           x-tick-step: .5,
diff --git a/src/plot/legend.typ b/src/plot/legend.typ
@@ -216,7 +216,7 @@
 ///     The preview canvas bounds are between (0,0) and (1,1).
 ///     If set to `auto`, a straight line is drawn.
 ///
-/// ```example
+/// ```cexample
 /// plot.plot(size: (1,1), x-tick-step: none, y-tick-step: none, {
 ///   plot.add(((0,0), (1,1))) // Some data
 ///   plot.add-legend([Custom item], preview: () => {
diff --git a/src/plot/line.typ b/src/plot/line.typ
diff --git a/src/smartart/common.typ b/src/smartart/common.typ
diff --git a/src/smartart/cycle.typ b/src/smartart/cycle.typ
diff --git a/src/smartart/process.typ b/src/smartart/process.typ
