konevsa/typst
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve documentation for figure kind (#2654)

Browse Source
This commit is contained in:
Malo 2023-11-13 12:18:05 +01:00 committed by GitHub
parent e07275163f
commit 8219ec2595
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/typst-library/src/meta/figure.rs
View File

@ -10,7 +10,7 @@ use crate::visualize::ImageElem;
/// A figure with an optional caption.
///
/// Automatically detects its contents to select the correct counting track. For
/// Automatically detects its kind to select the correct counting track. For
/// example, figures containing images will be numbered separately from figures
/// containing tables.
///
@ -124,8 +124,12 @@ pub struct FigureElem {
/// The kind of figure this is.
///
/// All figures of the same kind share a common counter.
///
/// If set to `{auto}`, the figure will try to automatically determine its
/// kind. All figures of the same kind share a common counter.
/// kind based on the type of its body. Automatically detected kinds are
/// [tables]($table) and [code]($raw). In other cases, the inferred kind is
/// that of an [image]($image).
///
/// Setting this to something other than `{auto}` will override the
/// automatic detection. This can be useful if
@ -135,8 +139,9 @@ pub struct FigureElem {
/// its content.
///
/// You can set the kind to be an element function or a string. If you set
/// it to an element function that is not supported by the figure, you will
/// need to manually specify the figure's supplement.
/// it to an element function other than [`{table}`]($table), [`{raw}`](raw)
/// or [`{image}`](image), you will need to manually specify the figure's
/// supplement.
///
/// ```example
/// #figure(