From 5cf3738145e4a87c7da4a5d475546164e04ccae4 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Wed, 2 Jul 2025 09:10:15 -0500 Subject: [PATCH 1/2] docs: Cover Renderer::render --- src/renderer/mod.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/renderer/mod.rs b/src/renderer/mod.rs index 65035c3..608613b 100644 --- a/src/renderer/mod.rs +++ b/src/renderer/mod.rs @@ -225,6 +225,7 @@ impl Renderer { } impl Renderer { + /// Render a diagnostic, a series of [`Group`]s pub fn render(&self, groups: &[Group<'_>]) -> String { if self.short_message { self.render_short_message(groups).unwrap() From 981ef5b9f8031c15fb18b264090ec46d2a155f6e Mon Sep 17 00:00:00 2001 From: Ed Page Date: Wed, 2 Jul 2025 09:29:50 -0500 Subject: [PATCH 2/2] docs: Describe groups --- src/snippet.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/snippet.rs b/src/snippet.rs index 1b317d7..af06326 100644 --- a/src/snippet.rs +++ b/src/snippet.rs @@ -18,6 +18,10 @@ pub(crate) struct Id<'a> { } /// An [`Element`] container +/// +/// A [diagnostic][crate::Renderer::render] is made of several `Group`s. +/// `Group`s are used to [annotate][AnnotationKind::Primary] [`Snippet`]s +/// with different [semantic reasons][Title]. #[derive(Clone, Debug)] pub struct Group<'a> { pub(crate) primary_level: Level<'a>,