docs: Document precisely what evalId produces in both cases, stripp…

…ing off the square brackets
mkdocstrings · Jan 13, 2024 · e339d10 · e339d10
1 parent a6e373b
commit e339d10
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/mkdocs_autorefs/references.py b/src/mkdocs_autorefs/references.py
@@ -65,7 +65,8 @@ def handleMatch(self, m: Match[str], data: Any) -> Element | EvalIDType:  # type
     def evalId(self, data: str, index: int, text: str) -> EvalIDType:  # noqa: N802 (parent's casing)
         """Evaluate the id portion of `[ref][id]`.
 
-        If `[ref][]` use `[ref]`.
+        If `[ref][]` use "ref".
+        If `[ref][id]` use "id".
 
         Arguments:
             data: The data to evaluate.