Clarify the path argument of the image element (#4892)

Co-authored-by: Laurenz <laurmaedje@gmail.com>
Co-authored-by: Martin Haug <mhaug@live.de>

9 files changed, 19 insertions, 1 deletions

diff --git a/crates/typst/src/foundations/plugin.rs b/crates/typst/src/foundations/plugin.rs
index 57dea827..4dc03014 100644
--- a/crates/typst/src/foundations/plugin.rs
+++ b/crates/typst/src/foundations/plugin.rs
@@ -155,6 +155,8 @@ impl Plugin {
         /// The engine.
         engine: &mut Engine,
         /// Path to a WebAssembly file.
+        ///
+        /// For more details, see the [Paths section]($syntax/#paths).
         path: Spanned<EcoString>,
     ) -> SourceResult<Plugin> {
         let Spanned { v: path, span } = path;
diff --git a/crates/typst/src/loading/cbor.rs b/crates/typst/src/loading/cbor.rs
index bce09271..e2d0f7c7 100644
--- a/crates/typst/src/loading/cbor.rs
+++ b/crates/typst/src/loading/cbor.rs
@@ -22,6 +22,8 @@ pub fn cbor(
     /// The engine.
     engine: &mut Engine,
     /// Path to a CBOR file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
 ) -> SourceResult<Value> {
     let Spanned { v: path, span } = path;
diff --git a/crates/typst/src/loading/csv.rs b/crates/typst/src/loading/csv.rs
index 4548bbd7..62a9bf69 100644
--- a/crates/typst/src/loading/csv.rs
+++ b/crates/typst/src/loading/csv.rs
@@ -29,6 +29,8 @@ pub fn csv(
     /// The engine.
     engine: &mut Engine,
     /// Path to a CSV file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
     /// The delimiter that separates columns in the CSV file.
     /// Must be a single ASCII character.
diff --git a/crates/typst/src/loading/json.rs b/crates/typst/src/loading/json.rs
index 8e829594..d466d043 100644
--- a/crates/typst/src/loading/json.rs
+++ b/crates/typst/src/loading/json.rs
@@ -54,6 +54,8 @@ pub fn json(
     /// The engine.
     engine: &mut Engine,
     /// Path to a JSON file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
 ) -> SourceResult<Value> {
     let Spanned { v: path, span } = path;
diff --git a/crates/typst/src/loading/read.rs b/crates/typst/src/loading/read.rs
index ff7f6b43..3bec9bd7 100644
--- a/crates/typst/src/loading/read.rs
+++ b/crates/typst/src/loading/read.rs
@@ -27,6 +27,8 @@ pub fn read(
     /// The engine.
     engine: &mut Engine,
     /// Path to a file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
     /// The encoding to read the file with.
     ///
diff --git a/crates/typst/src/loading/toml.rs b/crates/typst/src/loading/toml.rs
index 6884e6fe..17ab6b53 100644
--- a/crates/typst/src/loading/toml.rs
+++ b/crates/typst/src/loading/toml.rs
@@ -32,6 +32,8 @@ pub fn toml(
     /// The engine.
     engine: &mut Engine,
     /// Path to a TOML file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
 ) -> SourceResult<Value> {
     let Spanned { v: path, span } = path;
diff --git a/crates/typst/src/loading/xml.rs b/crates/typst/src/loading/xml.rs
index 1c494e78..fefb63c2 100644
--- a/crates/typst/src/loading/xml.rs
+++ b/crates/typst/src/loading/xml.rs
@@ -61,6 +61,8 @@ pub fn xml(
     /// The engine.
     engine: &mut Engine,
     /// Path to an XML file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
 ) -> SourceResult<Value> {
     let Spanned { v: path, span } = path;
diff --git a/crates/typst/src/loading/yaml.rs b/crates/typst/src/loading/yaml.rs
index d578eda4..22311cf6 100644
--- a/crates/typst/src/loading/yaml.rs
+++ b/crates/typst/src/loading/yaml.rs
@@ -44,6 +44,8 @@ pub fn yaml(
     /// The engine.
     engine: &mut Engine,
     /// Path to a YAML file.
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     path: Spanned<EcoString>,
 ) -> SourceResult<Value> {
     let Spanned { v: path, span } = path;
diff --git a/crates/typst/src/visualize/image/mod.rs b/crates/typst/src/visualize/image/mod.rs
index d267ca04..aeebb471 100644
--- a/crates/typst/src/visualize/image/mod.rs
+++ b/crates/typst/src/visualize/image/mod.rs
@@ -54,7 +54,9 @@ use crate::World;
 /// [gh-svg]: https://github.com/typst/typst/issues?q=is%3Aopen+is%3Aissue+label%3Asvg
 #[elem(scope, Show, LocalName, Figurable)]
 pub struct ImageElem {
-    /// Path to an image file.
+    /// Path to an image file
+    ///
+    /// For more details, see the [Paths section]($syntax/#paths).
     #[required]
     #[parse(
         let Spanned { v: path, span } =