From 384ea38bd9fa5d39388f346e82f00d92f0ad54b6 Mon Sep 17 00:00:00 2001
From: Ethan P <eth-p+git@hidden.email>
Date: Fri, 15 May 2020 14:21:38 -0700
Subject: [PATCH] Add documentation to InputDescription

---
 src/input.rs | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/input.rs b/src/input.rs
index eeb9a494..ed1869b7 100644
--- a/src/input.rs
+++ b/src/input.rs
@@ -8,10 +8,17 @@ use crate::error::*;
 
 const THEME_PREVIEW_FILE: &[u8] = include_bytes!("../assets/theme_preview.rs");
 
+/// A description for an Input source.
+/// This tells bat how to refer to the input.
 #[derive(Debug, Clone)]
 pub(crate) struct InputDescription {
+    /// The name of the input used when printing warnings.
     pub full: String,
+
+    /// The prefix string for the input when displaying it in the header.
     pub prefix: String,
+
+    /// The name of the input.
     pub name: String,
 }