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/searchresult.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'src/searchresult.rs')

diff --git a/src/searchresult.rs b/src/searchresult.rs
index 6a0dd30..cc882ff 100644
--- a/src/searchresult.rs
+++ b/src/searchresult.rs
@@ -1,4 +1,5 @@
-
+/// This struct is returned by the index::Index::search
+/// function.
 pub struct SearchResult {
     pub priority : u64,
     pub path : String
-- 
cgit v1.2.3-70-g09d2