summaryrefslogtreecommitdiff
path: root/library/src/meta
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2023-05-11 11:36:25 +0200
committerLaurenz <laurmaedje@gmail.com>2023-05-11 11:36:25 +0200
commit8ac7be95e660da3e67ac499410450793eaa18429 (patch)
treed6dc3a54747ef9d9ca445e2d705d25ca945a67e8 /library/src/meta
parent998a3c44fd79eac92c375ec9e755288bc146a279 (diff)
Documentation fixes
Diffstat (limited to 'library/src/meta')
-rw-r--r--library/src/meta/figure.rs14
-rw-r--r--library/src/meta/reference.rs7
2 files changed, 7 insertions, 14 deletions
diff --git a/library/src/meta/figure.rs b/library/src/meta/figure.rs
index bfbfeb83..548233c4 100644
--- a/library/src/meta/figure.rs
+++ b/library/src/meta/figure.rs
@@ -331,11 +331,8 @@ impl FigureElem {
.cloned()
}
- /// Builds the supplement and numbering of the figure.
- /// If there is no numbering, returns [`None`].
- ///
- /// # Errors
- /// If a numbering is specified but the [`Self::data()`] is `None`.
+ /// Builds the supplement and numbering of the figure. Returns [`None`] if
+ /// there is no numbering.
pub fn show_supplement_and_numbering(
&self,
vt: &mut Vt,
@@ -364,11 +361,8 @@ impl FigureElem {
}
}
- /// Builds the caption for the figure.
- /// If there is a numbering, will also try to show the supplement and the numbering.
- ///
- /// # Errors
- /// If a numbering is specified but the [`Self::element`] is `None`.
+ /// Builds the caption for the figure. If there is a numbering, will also
+ /// try to show the supplement and the numbering.
pub fn show_caption(&self, vt: &mut Vt) -> SourceResult<Content> {
let Some(mut caption) = self.caption(StyleChain::default()) else {
return Ok(Content::empty());
diff --git a/library/src/meta/reference.rs b/library/src/meta/reference.rs
index ceb1a3b2..e4b6bbec 100644
--- a/library/src/meta/reference.rs
+++ b/library/src/meta/reference.rs
@@ -245,10 +245,9 @@ cast_to_value! {
}
}
-/// Marks an element as being able to be referenced.
-/// This is used to implement the `@ref` macro.
-/// It is expected to build the [`Content`] that gets linked
-/// by the [`RefElement`].
+/// Marks an element as being able to be referenced. This is used to implement
+/// the `@ref` element. It is expected to build the [`Content`] that gets linked
+/// by the [`RefElem`].
pub trait Refable {
/// Tries to build a reference content for this element.
///