From cb7079711a75df0126a8e02f0d6b0620495637ec Mon Sep 17 00:00:00 2001
From: Laurenz <laurmaedje@gmail.com>
Date: Mon, 9 Oct 2023 13:58:39 +0200
Subject: [PATCH] Expand label docs

Co-Authored-By: Andrew Voynov <37143421+Andrew15-5@users.noreply.github.com>
---
 crates/typst/src/model/label.rs | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/crates/typst/src/model/label.rs b/crates/typst/src/model/label.rs
index 0beb3bfc4..117a682ae 100644
--- a/crates/typst/src/model/label.rs
+++ b/crates/typst/src/model/label.rs
@@ -6,9 +6,12 @@ use crate::eval::{func, scope, ty, Repr};
 
 /// A label for an element.
 ///
-/// Inserting a label into content attaches it to the closest previous element
-/// that is not a space. Then, the element can be [referenced]($ref) and styled
-/// through the label.
+/// Inserting a label into content attaches it to the closest preceding element
+/// that is not a space. The preceding element must be in the same scope as the
+/// label, which means that `[Hello #[<label>]]`, for instance, wouldn't work.
+///
+/// A labelled element can be [referenced]($ref), [queried]($query) for, and
+/// [styled]($styling) through its label.
 ///
 /// # Example
 /// ```example
@@ -22,6 +25,9 @@ use crate::eval::{func, scope, ty, Repr};
 /// # Syntax
 /// This function also has dedicated syntax: You can create a label by enclosing
 /// its name in angle brackets. This works both in markup and code.
+///
+/// Currently, labels can only be attached to elements in markup mode, not in
+/// code mode. This might change in the future.
 #[ty(scope)]
 #[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
 pub struct Label(pub EcoString);