Remove references to non existent DisplayListFormatter

Author: zzau13

README.md

@@ -35,49 +35,47 @@ Usage
 
 ```rust
 use annotate_snippets::{
-    display_list::DisplayList,
-    formatter::DisplayListFormatter,
+    display_list::{DisplayList, FormatOptions},
     snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
 };
 
 fn main() {
     let snippet = Snippet {
         title: Some(Annotation {
-            label: Some("expected type, found `22`".to_string()),
+            label: Some("expected type, found `22`"),
             id: None,
             annotation_type: AnnotationType::Error,
         }),
         footer: vec![],
-        slices: vec![
-            Slice {
-                source: r#"
-This is an example
-content of the slice
-which will be annotated
-with the list of annotations below.
-                "#.to_string(),
-                line_start: 26,
-                origin: Some("examples/example.txt".to_string()),
-                fold: false,
-                annotations: vec![
-                    SourceAnnotation {
-                        label: "Example error annotation".to_string(),
-                        annotation_type: AnnotationType::Error,
-                        range: (13, 18),
-                    },
-                    SourceAnnotation {
-                        label: "and here's a warning".to_string(),
-                        annotation_type: AnnotationType::Warning,
-                        range: (34, 50),
-                    },
-                ],
-            },
-        ],
+        slices: vec![Slice {
+            source: r#"                annotations: vec![SourceAnnotation {
+                label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
+                    ,
+                range: <22, 25>,"#,
+            line_start: 26,
+            origin: Some("examples/footer.rs"),
+            fold: true,
+            annotations: vec![
+                SourceAnnotation {
+                    label: "",
+                    annotation_type: AnnotationType::Error,
+                    range: (205, 207),
+                },
+                SourceAnnotation {
+                    label: "while parsing this struct",
+                    annotation_type: AnnotationType::Info,
+                    range: (34, 50),
+                },
+            ],
+        }],
+        opt: FormatOptions {
+            color: true,
+            ..Default::default()
+        },
     };
 
     let dl = DisplayList::from(snippet);
-    let dlf = DisplayListFormatter::new(true, false);
-    println!("{}", dlf.format(&dl));
+    println!("{}", dl);
 }
 ```
 

src/display_list/structs.rs

@@ -280,8 +280,7 @@ pub enum DisplayMarkType {
 
 /// A type of the `Annotation` which may impact the sigils, style or text displayed.
 ///
-/// There are several ways in which the `DisplayListFormatter` uses this information
-/// when formatting the `DisplayList`:
+/// There are several ways to uses this information when formatting the `DisplayList`:
 ///
 /// * An annotation may display the name of the type like `error` or `info`.
 /// * An underline for `Error` may be `^^^` while for `Warning` it coule be `---`.

src/formatter/style.rs

@@ -39,8 +39,7 @@ pub trait Style {
         c: Box<dyn FnOnce(&mut fmt::Formatter<'_>) -> fmt::Result + 'a>,
         f: &mut fmt::Formatter<'_>,
     ) -> fmt::Result;
-    /// The method used by the DisplayListFormatter to display the message
-    /// in bold font.
+    /// The method used by the `Formatter` to display the message in bold font.
     fn bold(&self) -> Box<dyn Style>;
 }
 

src/lib.rs

@@ -38,15 +38,15 @@
 //! of lines containing semantic information about each line.
 //! This structure is the easiest to manipulate and organize.
 //!
-//! Finally, [DisplayListFormatter](self::formatter::DisplayListFormatter) is
-//! used to format the `DisplayList` using a `Stylesheet` into a final `String` output.
+//! Finally, `impl Display` into a final `String` output.
 //!
 //! A user of the crate may choose to provide their own equivalent of the input
 //! structure with an `Into<DisplayList>` trait.
 //!
 //! A user of the crate may also choose to provide their own formatter logic,
 //! to convert a `DisplayList` into a `String`, or just a `Stylesheet` to
 //! use the crate's formatting logic, but with a custom stylesheet.
+// TODO: check documentation
 
 pub mod display_list;
 pub mod formatter;

src/stylesheets/mod.rs

@@ -1,4 +1,4 @@
-//! List of stylesheets that can be used by the `DisplayListFormatter`.
+//! List of stylesheets
 //!
 //! The list depends on what optional dependencies the crate has been
 //! compiled with.