Documentation improvements (#5888)

crates/typst-library/src/foundations/symbol.rs

@@ -21,6 +21,7 @@ use crate::foundations::{
 /// be accessed using [field access notation]($scripting/#fields):
 ///
 /// - General symbols are defined in the [`sym` module]($category/symbols/sym)
+///   and are accessible without the `sym.` prefix in math mode.
 /// - Emoji are defined in the [`emoji` module]($category/symbols/emoji)
 ///
 /// Moreover, you can define custom symbols with this type's constructor

crates/typst-library/src/layout/grid/resolve.rs

@@ -1526,11 +1526,7 @@ impl<'a> CellGrid<'a> {
         self.entry(x, y).map(|entry| match entry {
             Entry::Cell(_) => Axes::new(x, y),
             Entry::Merged { parent } => {
-                let c = if self.has_gutter {
+                let c = self.non_gutter_column_count();
-                    1 + self.cols.len() / 2
-                } else {
-                    self.cols.len()
-                };
                 let factor = if self.has_gutter { 2 } else { 1 };
                 Axes::new(factor * (*parent % c), factor * (*parent / c))
             }
@@ -1602,6 +1598,21 @@ impl<'a> CellGrid<'a> {
             cell.rowspan.get()
         }
     }
+
+    #[inline]
+    pub fn non_gutter_column_count(&self) -> usize {
+        if self.has_gutter {
+            // Calculation: With gutters, we have
+            // 'cols = 2 * (non-gutter cols) - 1', since there is a gutter
+            // column between each regular column. Therefore,
+            // 'floor(cols / 2)' will be equal to
+            // 'floor(non-gutter cols - 1/2) = non-gutter-cols - 1',
+            // so 'non-gutter cols = 1 + floor(cols / 2)'.
+            1 + self.cols.len() / 2
+        } else {
+            self.cols.len()
+        }
+    }
 }
 
 /// Given a cell's requested x and y, the vector with the resolved cell

crates/typst-library/src/model/table.rs

@@ -282,7 +282,7 @@ fn show_cell_html(tag: HtmlTag, cell: &Cell, styles: StyleChain) -> Content {
 
 fn show_cellgrid_html(grid: CellGrid, styles: StyleChain) -> Content {
     let elem = |tag, body| HtmlElem::new(tag).with_body(Some(body)).pack();
-    let mut rows: Vec<_> = grid.entries.chunks(grid.cols.len()).collect();
+    let mut rows: Vec<_> = grid.entries.chunks(grid.non_gutter_column_count()).collect();
 
     let tr = |tag, row: &[Entry]| {
         let row = row

crates/typst-library/src/visualize/color.rs

@@ -130,7 +130,7 @@ static TO_SRGB: LazyLock<qcms::Transform> = LazyLock::new(|| {
 ///
 /// # Predefined color maps
 /// Typst also includes a number of preset color maps that can be used for
-/// [gradients]($gradient.linear). These are simply arrays of colors defined in
+/// [gradients]($gradient/#stops). These are simply arrays of colors defined in
 /// the module `color.map`.
 ///
 /// ```example

crates/typst-library/src/visualize/gradient.rs

@@ -70,6 +70,9 @@ use crate::visualize::{Color, ColorSpace, WeightedColor};
 /// the offsets when defining a gradient. In this case, Typst will space all
 /// stops evenly.
 ///
+/// Typst predefines color maps that you can use as stops. See the
+/// [`color`]($color/#predefined-color-maps) documentation for more details.
+///
 /// # Relativeness
 /// The location of the `{0%}` and `{100%}` stops depends on the dimensions
 /// of a container. This container can either be the shape that it is being
@@ -157,10 +160,6 @@ use crate::visualize::{Color, ColorSpace, WeightedColor};
 /// )
 /// ```
 ///
-/// # Presets
-/// Typst predefines color maps that you can use with your gradients. See the
-/// [`color`]($color/#predefined-color-maps) documentation for more details.
-///
 /// # Note on file sizes
 ///
 /// Gradients can be quite large, especially if they have many stops. This is
@@ -288,7 +287,7 @@ impl Gradient {
     ///   )),
     /// )
     /// ```
-    #[func]
+    #[func(title = "Radial Gradient")]
     fn radial(
         span: Span,
         /// The color [stops](#stops) of the gradient.
@@ -402,7 +401,7 @@ impl Gradient {
     ///   )),
     /// )
     /// ```
-    #[func]
+    #[func(title = "Conic Gradient")]
     pub fn conic(
         span: Span,
         /// The color [stops](#stops) of the gradient.

crates/typst-syntax/src/parser.rs

@@ -271,10 +271,11 @@ fn math_expr_prec(p: &mut Parser, min_prec: usize, stop: SyntaxKind) {
         }
 
         SyntaxKind::Text | SyntaxKind::MathText | SyntaxKind::MathShorthand => {
-            continuable = matches!(
+            continuable = !p.at(SyntaxKind::MathShorthand)
-                math_class(p.current_text()),
+                && matches!(
-                None | Some(MathClass::Alphabetic)
+                    math_class(p.current_text()),
-            );
+                    None | Some(MathClass::Alphabetic)
+                );
             if !maybe_delimited(p) {
                 p.eat();
             }

docs/reference/groups.yml

@@ -170,8 +170,8 @@
   category: symbols
   path: ["emoji"]
   details: |
-    Named emoji.
+    Named emojis.
 
     For example, `#emoji.face` produces the 😀 emoji. If you frequently use
     certain emojis, you can also import them from the `emoji` module (`[#import
-    emoji: face]`) to use them without the `#emoji.` prefix.
+    emoji: face]`) to use them without the `emoji.` prefix.

tests/ref/html/col-gutter-table.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+  </head>
+  <body>
+    <table>
+      <tr>
+        <td>a</td>
+        <td>b</td>
+        <td>c</td>
+      </tr>
+      <tr>
+        <td>d</td>
+        <td>e</td>
+        <td>f</td>
+      </tr>
+      <tr>
+        <td>g</td>
+        <td>h</td>
+        <td>i</td>
+      </tr>
+    </table>
+  </body>
+</html>

tests/ref/html/col-row-gutter-table.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+  </head>
+  <body>
+    <table>
+      <tr>
+        <td>a</td>
+        <td>b</td>
+        <td>c</td>
+      </tr>
+      <tr>
+        <td>d</td>
+        <td>e</td>
+        <td>f</td>
+      </tr>
+      <tr>
+        <td>g</td>
+        <td>h</td>
+        <td>i</td>
+      </tr>
+    </table>
+  </body>
+</html>

tests/ref/html/row-gutter-table.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+  </head>
+  <body>
+    <table>
+      <tr>
+        <td>a</td>
+        <td>b</td>
+        <td>c</td>
+      </tr>
+      <tr>
+        <td>d</td>
+        <td>e</td>
+        <td>f</td>
+      </tr>
+      <tr>
+        <td>g</td>
+        <td>h</td>
+        <td>i</td>
+      </tr>
+    </table>
+  </body>
+</html>

tests/suite/layout/grid/html.typ

@@ -30,3 +30,30 @@
     [row],
   ),
 )
+
+--- col-gutter-table html ---
+#table(
+  columns: 3,
+  column-gutter: 3pt,
+  [a], [b], [c],
+  [d], [e], [f],
+  [g], [h], [i]
+)
+
+--- row-gutter-table html ---
+#table(
+  columns: 3,
+  row-gutter: 3pt,
+  [a], [b], [c],
+  [d], [e], [f],
+  [g], [h], [i]
+)
+
+--- col-row-gutter-table html ---
+#table(
+  columns: 3,
+  gutter: 3pt,
+  [a], [b], [c],
+  [d], [e], [f],
+  [g], [h], [i]
+)

tests/suite/math/syntax.typ

@@ -13,6 +13,11 @@ $ underline(f' : NN -> RR) \
     1 - 0 thick &...,
   ) $
 
+--- math-shorthands-noncontinuable ---
+// Test that shorthands are not continuable.
+$ x >=(y) / z \
+  x >= (y) / z $
+
 --- math-common-symbols ---
 // Test common symbols.
 $ dot \ dots \ ast \ tilde \ star $