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

(limited to 'src/text')

diff --git a/src/text/mod.rs b/src/text/mod.rs
index dd969af..c3fd8f6 100644
--- a/src/text/mod.rs
+++ b/src/text/mod.rs
@@ -36,6 +36,9 @@ lazy_static! {
 }
 
 
+/// Extract text from files if there is an extractor.
+/// If there is an error like `permission denied` or there
+/// is no extractor this function returns a empty string.
 pub fn extract_text(path : &str) -> String {
     let p = Path::new(&path);
     let extenstion = p.extension().unwrap_or_else(|| OsStr::new("")).to_str().unwrap();
-- 
cgit v1.2.3-70-g09d2