Skip to content

Commit 283f20c

Browse files
committed
docs: More accuratly describe AnnotationKind variants
1 parent c195b83 commit 283f20c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/snippet.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -262,10 +262,13 @@ 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+
/// An [`Annotation`] which will use the "primary" underline character ('^'
266+
/// for [`OutputTheme::Ascii`], and '━' for [`OutputTheme::Unicode`]) and
267+
/// be colored according to the primary [`Level`] of the [`Group`].
267268
Primary,
268-
/// "secondary"; fixed color
269+
/// An [`Annotation`] which will use the "secondary" underline character (
270+
/// '-' for [`OutputTheme::Ascii`], and '─' for [`OutputTheme::Unicode`])
271+
/// and be colored according to [`Renderer::context`].
269272
Context,
270273
}
271274

0 commit comments

Comments
 (0)