More docs

Author: Zibi Braniecki

src/display_list/from_snippet.rs

@@ -141,7 +141,7 @@ fn fold_body(body: &[DisplayLine]) -> Vec<DisplayLine> {
                     };
                     for item in body.iter().take(fold_start + pre_len).skip(fold_start) {
                         new_body.push(item.clone());
-                    };
+                    }
                     new_body.push(DisplayLine::Fold {
                         inline_marks: inline_marks.clone(),
                     });

src/snippet.rs

@@ -1,3 +1,5 @@
+//! Structures used as an input for the library.
+
 /// Primary structure provided for formatting
 #[derive(Debug, Clone)]
 pub struct Snippet {
@@ -31,13 +33,15 @@ pub enum AnnotationType {
     Help,
 }
 
+/// An annotation for a `Slice`.
 #[derive(Debug, Clone)]
 pub struct SourceAnnotation {
     pub range: (usize, usize),
     pub label: String,
     pub annotation_type: AnnotationType,
 }
 
+/// An annotation for a `Snippet`.
 #[derive(Debug, Clone)]
 pub struct Annotation {
     /// Identifier of the annotation. Usually error code like "E0308".

src/stylesheets/mod.rs

@@ -1,3 +1,11 @@
+//! List of stylesheets that can be used by the `DisplayListFormatter`.
+//!
+//! The list depends on what optional dependencies the crate has been
+//! compiled with.
+//!
+//! By default the `no_color` is available. If the crate gets compiled
+//! with `ansi_term`, the `color` stylesheet is added.
+
 #[cfg(feature = "ansi_term")]
 pub mod color;
 pub mod no_color;

tests/dl_from_snippet.rs

@@ -235,36 +235,40 @@ fn test_format_slice_annotation_standalone() {
 fn test_format_label() {
     let input = snippet::Snippet {
         title: None,
-        footer: vec![snippet::Annotation {
-            id: None,
-            label: Some("This __is__ a title".to_string()),
-            annotation_type: snippet::AnnotationType::Error,
-        }],
+        footer: vec![
+            snippet::Annotation {
+                id: None,
+                label: Some("This __is__ a title".to_string()),
+                annotation_type: snippet::AnnotationType::Error,
+            },
+        ],
         slices: vec![],
     };
     let output = dl::DisplayList {
-        body: vec![dl::DisplayLine::Raw(dl::DisplayRawLine::Annotation {
-            annotation: dl::Annotation {
-                annotation_type: dl::DisplayAnnotationType::Error,
-                id: None,
-                label: vec![
-                    dl::DisplayTextFragment {
-                        content: "This ".to_string(),
-                        style: dl::DisplayTextStyle::Regular,
-                    },
-                    dl::DisplayTextFragment {
-                        content: "is".to_string(),
-                        style: dl::DisplayTextStyle::Emphasis,
-                    },
-                    dl::DisplayTextFragment {
-                        content: " a title".to_string(),
-                        style: dl::DisplayTextStyle::Regular,
-                    },
-                ],
-            },
-            source_aligned: true,
-            continuation: false,
-        })],
+        body: vec![
+            dl::DisplayLine::Raw(dl::DisplayRawLine::Annotation {
+                annotation: dl::Annotation {
+                    annotation_type: dl::DisplayAnnotationType::Error,
+                    id: None,
+                    label: vec![
+                        dl::DisplayTextFragment {
+                            content: "This ".to_string(),
+                            style: dl::DisplayTextStyle::Regular,
+                        },
+                        dl::DisplayTextFragment {
+                            content: "is".to_string(),
+                            style: dl::DisplayTextStyle::Emphasis,
+                        },
+                        dl::DisplayTextFragment {
+                            content: " a title".to_string(),
+                            style: dl::DisplayTextStyle::Regular,
+                        },
+                    ],
+                },
+                source_aligned: true,
+                continuation: false,
+            }),
+        ],
     };
     assert_eq!(dl::DisplayList::from(input), output);
 }