Skip to content

Commit 4e70f56

Browse files
committed
docs: More accuratly describe AnnotationKind variants
1 parent c195b83 commit 4e70f56

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/snippet.rs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,10 +262,14 @@ impl<'a> Annotation<'a> {
262262
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
263263
#[non_exhaustive]
264264
pub enum AnnotationKind {
265-
/// Color to the [`Level`] the first [`Title`] in [`Group`]. If no [`Title`]
266-
/// is present, it will default to `error`.
265+
/// Match the primary [`Level`] of the group.
267266
Primary,
268-
/// "secondary"; fixed color
267+
/// Additional context to explain the [`Primary`][Self::Primary]
268+
/// [`Annotation`]
269+
///
270+
/// See also [`Renderer::context`].
271+
///
272+
/// [`Renderer::context`]: crate::renderer::Renderer
269273
Context,
270274
}
271275

0 commit comments

Comments
 (0)