From 489492ab15aa0ab51bd63f7d087f3bd51b0783e7 Mon Sep 17 00:00:00 2001
From: davidemazzocchi <davide.mazzocchi@gmail.com>
Date: Sat, 18 Oct 2025 20:03:50 +0200
Subject: [PATCH] doc: add initial documentation for load_by_filter function in
 catalog

---
 01.workspace/heave/src/str/catalog.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/01.workspace/heave/src/str/catalog.rs b/01.workspace/heave/src/str/catalog.rs
index 33c1225..854311d 100644
--- a/01.workspace/heave/src/str/catalog.rs
+++ b/01.workspace/heave/src/str/catalog.rs
@@ -214,6 +214,8 @@ impl Catalog {
         Ok(())
     }
 
+    /// Loads all entities matching the filter values
+    /// Different entity class with clashing attribute names might be loaded
     pub fn load_by_filter(&mut self, filter: &Filter) -> Result<(), FailedTo> {
         let path = path::Path::new(&self.path);
         let entities = sqlite::load::by_filter(path, filter).map_err(|_| FailedTo::LoadFromDB)?;