mirror of
https://github.com/typst/typst
synced 2025-08-11 21:57:55 +08:00
Link to the Path section consistently
This commit is contained in:
parent
5efb33e504
commit
03fba630f9
@ -148,9 +148,7 @@ use crate::loading::{DataSource, Load};
|
||||
#[func(scope)]
|
||||
pub fn plugin(
|
||||
engine: &mut Engine,
|
||||
/// A path to a WebAssembly file or raw WebAssembly bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to a WebAssembly file or raw WebAssembly bytes.
|
||||
source: Spanned<DataSource>,
|
||||
) -> SourceResult<Module> {
|
||||
let data = source.load(engine.world)?;
|
||||
|
@ -20,9 +20,7 @@ use crate::loading::{DataSource, Load};
|
||||
#[func(scope, title = "CBOR")]
|
||||
pub fn cbor(
|
||||
engine: &mut Engine,
|
||||
/// A path to a CBOR file or raw CBOR bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to a CBOR file or raw CBOR bytes.
|
||||
source: Spanned<DataSource>,
|
||||
) -> SourceResult<Value> {
|
||||
let data = source.load(engine.world)?;
|
||||
|
@ -26,9 +26,7 @@ use crate::loading::{DataSource, Load, Readable};
|
||||
#[func(scope, title = "CSV")]
|
||||
pub fn csv(
|
||||
engine: &mut Engine,
|
||||
/// Path to a CSV file or raw CSV bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to a CSV file or raw CSV bytes.
|
||||
source: Spanned<DataSource>,
|
||||
/// The delimiter that separates columns in the CSV file.
|
||||
/// Must be a single ASCII character.
|
||||
|
@ -51,9 +51,7 @@ use crate::loading::{DataSource, Load, Readable};
|
||||
#[func(scope, title = "JSON")]
|
||||
pub fn json(
|
||||
engine: &mut Engine,
|
||||
/// Path to a JSON file or raw JSON bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to a JSON file or raw JSON bytes.
|
||||
source: Spanned<DataSource>,
|
||||
) -> SourceResult<Value> {
|
||||
let data = source.load(engine.world)?;
|
||||
|
@ -29,9 +29,7 @@ use crate::loading::{DataSource, Load, Readable};
|
||||
#[func(scope, title = "TOML")]
|
||||
pub fn toml(
|
||||
engine: &mut Engine,
|
||||
/// A path to a TOML file or raw TOML bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to a TOML file or raw TOML bytes.
|
||||
source: Spanned<DataSource>,
|
||||
) -> SourceResult<Value> {
|
||||
let data = source.load(engine.world)?;
|
||||
|
@ -58,9 +58,7 @@ use crate::loading::{DataSource, Load, Readable};
|
||||
#[func(scope, title = "XML")]
|
||||
pub fn xml(
|
||||
engine: &mut Engine,
|
||||
/// A path to an XML file or raw XML bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to an XML file or raw XML bytes.
|
||||
source: Spanned<DataSource>,
|
||||
) -> SourceResult<Value> {
|
||||
let data = source.load(engine.world)?;
|
||||
|
@ -41,9 +41,7 @@ use crate::loading::{DataSource, Load, Readable};
|
||||
#[func(scope, title = "YAML")]
|
||||
pub fn yaml(
|
||||
engine: &mut Engine,
|
||||
/// A path to a YAML file or raw YAML bytes.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
/// A [path]($syntax/#paths) to a YAML file or raw YAML bytes.
|
||||
source: Spanned<DataSource>,
|
||||
) -> SourceResult<Value> {
|
||||
let data = source.load(engine.world)?;
|
||||
|
@ -32,12 +32,10 @@ use crate::World;
|
||||
/// embedded file conforms to PDF/A-1 or PDF/A-2.
|
||||
#[elem(Show, Locatable)]
|
||||
pub struct EmbedElem {
|
||||
/// Path of the file to be embedded.
|
||||
/// The [path]($syntax/#paths) of the file to be embedded.
|
||||
///
|
||||
/// Must always be specified, but is only read from if no data is provided
|
||||
/// in the following argument.
|
||||
///
|
||||
/// For more details about paths, see the [Paths section]($syntax/#paths).
|
||||
#[required]
|
||||
#[parse(
|
||||
let Spanned { v: path, span } =
|
||||
|
Loading…
x
Reference in New Issue
Block a user