Skip to content

Commit 838537f

Browse files
committed
docs: Describe Origin::primary
1 parent 8277349 commit 838537f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/snippet.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,9 +267,9 @@ impl<'a> Annotation<'a> {
267267
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
268268
#[non_exhaustive]
269269
pub enum AnnotationKind {
270-
/// Match the primary [`Level`] of the group.
270+
/// Shows the source that the [Group's Title][Group::with_title] references
271271
///
272-
/// See [`Group::with_level`] for details about how this is determined
272+
/// For [`Title`]-less groups, see [`Group::with_level`]
273273
Primary,
274274
/// Additional context to explain the [`Primary`][Self::Primary]
275275
/// [`Annotation`]
@@ -413,6 +413,7 @@ impl<'a> Origin<'a> {
413413
self
414414
}
415415

416+
/// Mark this as the source that the [Group's Title][Group::with_title] references
416417
pub fn primary(mut self, primary: bool) -> Self {
417418
self.primary = primary;
418419
self

0 commit comments

Comments
 (0)