From 2063b928851c27e51247cace61af02f85e82e59a Mon Sep 17 00:00:00 2001 From: Philipp Hansch Date: Fri, 6 Sep 2019 07:04:16 +0200 Subject: [PATCH] Small update to `Slice` docs from https://github.com/rust-lang/annotate-snippets-rs/issues/9#issuecomment-528113617 --- src/snippet.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/snippet.rs b/src/snippet.rs index 6566b0f6..211f8e07 100644 --- a/src/snippet.rs +++ b/src/snippet.rs @@ -40,6 +40,9 @@ pub struct Snippet { /// Structure containing the slice of text to be annotated and /// basic information about the location of the slice. +/// +/// One `Slice` is meant to represent a single, continuous, +/// slice of source code that you want to annotate. #[derive(Debug, Clone)] pub struct Slice { pub source: String,