summaryrefslogtreecommitdiff
path: root/crates
diff options
context:
space:
mode:
authorAndrew Voynov <37143421+Andrew15-5@users.noreply.github.com>2024-03-11 16:33:15 +0300
committerGitHub <noreply@github.com>2024-03-11 13:33:15 +0000
commitd01ccffad6470ad49d4e47b5c0884dfd23305961 (patch)
treeb624edb13270c50ecdd47c2877efff3e1b3a69d1 /crates
parent515f5b6b4f6afd8c7487f04769495aafee506543 (diff)
Improved docs for table/grid (#3615)
Diffstat (limited to 'crates')
-rw-r--r--crates/typst/src/layout/grid/mod.rs10
-rw-r--r--crates/typst/src/model/table.rs20
2 files changed, 16 insertions, 14 deletions
diff --git a/crates/typst/src/layout/grid/mod.rs b/crates/typst/src/layout/grid/mod.rs
index 4276f05c..4ad096eb 100644
--- a/crates/typst/src/layout/grid/mod.rs
+++ b/crates/typst/src/layout/grid/mod.rs
@@ -164,7 +164,7 @@ pub struct GridElem {
#[borrowed]
pub rows: TrackSizings,
- /// The gaps between rows & columns.
+ /// The gaps between rows and columns.
///
/// If there are more gutters than defined sizes, the last gutter is repeated.
#[external]
@@ -185,9 +185,9 @@ pub struct GridElem {
/// How to fill the cells.
///
- /// This can be a color or a function that returns a color. The function is
- /// passed the cells' column and row indices, starting at zero. This can be
- /// used to implement striped grids.
+ /// This can be a color or a function that returns a color. The function
+ /// receives the cells' column and row indices, starting from zero. This can
+ /// be used to implement striped grids.
///
/// ```example
/// #grid(
@@ -210,7 +210,7 @@ pub struct GridElem {
///
/// This can either be a single alignment, an array of alignments
/// (corresponding to each column) or a function that returns an alignment.
- /// The function is passed the cells' column and row indices, starting at
+ /// The function receives the cells' column and row indices, starting from
/// zero. If set to `{auto}`, the outer alignment is used.
///
/// You can find an example for this argument at the
diff --git a/crates/typst/src/model/table.rs b/crates/typst/src/model/table.rs
index 3d3ea0ec..8eaf55a9 100644
--- a/crates/typst/src/model/table.rs
+++ b/crates/typst/src/model/table.rs
@@ -129,8 +129,8 @@ pub struct TableElem {
#[borrowed]
pub rows: TrackSizings,
- /// The gaps between rows & columns. See the [grid documentation]($grid) for
- /// more information on gutters.
+ /// The gaps between rows and columns. See the [grid documentation]($grid)
+ /// for more information on gutters.
#[external]
pub gutter: TrackSizings,
@@ -151,13 +151,15 @@ pub struct TableElem {
/// How to fill the cells.
///
- /// This can be a color or a function that returns a color. The function is
- /// passed the cells' column and row indices, starting at zero. This can be
- /// used to implement striped tables.
+ /// This can be a color or a function that returns a color. The function
+ /// receives the cells' column and row indices, starting from zero. This can
+ /// be used to implement striped tables.
///
/// ```example
/// #table(
- /// fill: (col, _) => if calc.odd(col) { luma(240) } else { white },
+ /// fill: (col, _) =>
+ /// if calc.odd(col) { luma(240) }
+ /// else { white },
/// align: (col, row) =>
/// if row == 0 { center }
/// else if col == 0 { left }
@@ -176,7 +178,7 @@ pub struct TableElem {
///
/// This can either be a single alignment, an array of alignments
/// (corresponding to each column) or a function that returns an alignment.
- /// The function is passed the cells' column and row indices, starting at
+ /// The function receives the cells' column and row indices, starting from
/// zero. If set to `{auto}`, the outer alignment is used.
///
/// ```example
@@ -683,8 +685,8 @@ pub struct TableVLine {
/// properties for a particular cell, or use it in show rules to apply certain
/// styles to multiple cells at once.
///
-/// Perhaps the most important use-case of `{table.cell}` is to make a cell span
-/// multiple columns or rows with the `colspan` and `rowspan` fields.
+/// Perhaps the most important use case of `{table.cell}` is to make a cell span
+/// multiple columns and/or rows with the `colspan` and `rowspan` fields.
///
/// ```example
/// >>> #set page(width: auto)