From 9b4aa4e9643b0a5b4a554e455eac269a2472b590 Mon Sep 17 00:00:00 2001
From: Nathan Reiner <nathan@nathanreiner.xyz>
Date: Thu, 6 Jul 2023 14:20:14 +0200
Subject: add some documentation to structs

---
 src/index.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/index.rs')

diff --git a/src/index.rs b/src/index.rs
index 8c358d3..616682d 100644
--- a/src/index.rs
+++ b/src/index.rs
@@ -12,6 +12,8 @@ use crate::text;
 use crate::splitter;
 use crate::vector;
 
+/// Represents a Index which is ether generated
+/// or read from a file.
 pub struct Index {
     dictionary : Dictionary,
     filecache : Vec<FileCache>,
-- 
cgit v1.2.3-70-g09d2