fix!: Rename SourceAnnotation to Annotation

Author: epage

src/snippet.rs

@@ -100,9 +100,9 @@ impl<'a> Label<'a> {
         self
     }
 
-    /// Create a [`SourceAnnotation`] with the given span for a [`Slice`]
-    pub fn span(&self, span: Range<usize>) -> SourceAnnotation<'a> {
-        SourceAnnotation {
+    /// Create a [`Annotation`] with the given span for a [`Slice`]
+    pub fn span(&self, span: Range<usize>) -> Annotation<'a> {
+        Annotation {
             range: span,
             label: self.label,
             level: self.level,
@@ -119,7 +119,7 @@ pub struct Slice<'a> {
     pub(crate) source: &'a str,
     pub(crate) line_start: usize,
     pub(crate) origin: Option<&'a str>,
-    pub(crate) annotations: Vec<SourceAnnotation<'a>>,
+    pub(crate) annotations: Vec<Annotation<'a>>,
     pub(crate) fold: bool,
 }
 
@@ -139,7 +139,7 @@ impl<'a> Slice<'a> {
         self
     }
 
-    pub fn annotation(mut self, annotation: SourceAnnotation<'a>) -> Self {
+    pub fn annotation(mut self, annotation: Annotation<'a>) -> Self {
         self.annotations.push(annotation);
         self
     }
@@ -166,7 +166,7 @@ pub enum Level {
 ///
 /// This gets created by [`Label::span`].
 #[derive(Debug)]
-pub struct SourceAnnotation<'a> {
+pub struct Annotation<'a> {
     /// The byte range of the annotation in the `source` string
     pub(crate) range: Range<usize>,
     pub(crate) label: &'a str,

tests/fixtures/deserialize.rs

@@ -1,9 +1,7 @@
 use serde::{Deserialize, Deserializer, Serialize};
 use std::ops::Range;
 
-use annotate_snippets::{
-    renderer::Margin, Label, Level, Renderer, Slice, Snippet, SourceAnnotation,
-};
+use annotate_snippets::{renderer::Margin, Annotation, Label, Level, Renderer, Slice, Snippet};
 
 #[derive(Deserialize)]
 pub struct Fixture<'a> {
@@ -105,9 +103,9 @@ pub struct SliceDef<'a> {
     pub line_start: usize,
     #[serde(borrow)]
     pub origin: Option<&'a str>,
-    #[serde(deserialize_with = "deserialize_source_annotations")]
+    #[serde(deserialize_with = "deserialize_annotations")]
     #[serde(borrow)]
-    pub annotations: Vec<SourceAnnotation<'a>>,
+    pub annotations: Vec<Annotation<'a>>,
     #[serde(default)]
     pub fold: bool,
 }
@@ -132,31 +130,29 @@ impl<'a> From<SliceDef<'a>> for Slice<'a> {
     }
 }
 
-fn deserialize_source_annotations<'de, D>(
-    deserializer: D,
-) -> Result<Vec<SourceAnnotation<'de>>, D::Error>
+fn deserialize_annotations<'de, D>(deserializer: D) -> Result<Vec<Annotation<'de>>, D::Error>
 where
     D: Deserializer<'de>,
 {
     #[derive(Deserialize)]
-    struct Wrapper<'a>(#[serde(borrow)] SourceAnnotationDef<'a>);
+    struct Wrapper<'a>(#[serde(borrow)] AnnotationDef<'a>);
 
     let v = Vec::deserialize(deserializer)?;
     Ok(v.into_iter().map(|Wrapper(a)| a.into()).collect())
 }
 
 #[derive(Serialize, Deserialize)]
-pub struct SourceAnnotationDef<'a> {
+pub struct AnnotationDef<'a> {
     pub range: Range<usize>,
     #[serde(borrow)]
     pub label: &'a str,
     #[serde(with = "LevelDef")]
     pub level: Level,
 }
 
-impl<'a> From<SourceAnnotationDef<'a>> for SourceAnnotation<'a> {
-    fn from(val: SourceAnnotationDef<'a>) -> Self {
-        let SourceAnnotationDef {
+impl<'a> From<AnnotationDef<'a>> for Annotation<'a> {
+    fn from(val: AnnotationDef<'a>) -> Self {
+        let AnnotationDef {
             range,
             label,
             level,