Merge pull request #240 from epage/docs

docs: Document more of the API

Author: Muscraft

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()

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>,