From 20f0aed2ed17aeb6b8a4f6c861c594641f458954 Mon Sep 17 00:00:00 2001
From: William Casarin <jb55@jb55.com>
Date: Wed, 31 Jul 2024 14:21:47 -0700
Subject: [PATCH] doc: add docs for get_unknown_note_ids

Signed-off-by: William Casarin <jb55@jb55.com>
---
 src/app.rs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/app.rs b/src/app.rs
index c7eb45a..3b498d5 100644
--- a/src/app.rs
+++ b/src/app.rs
@@ -269,6 +269,14 @@ impl<'a> UnknownId<'a> {
     }
 }
 
+/// Look for missing notes in various parts of notes that we see:
+///
+/// - pubkeys and notes mentioned inside the note
+/// - notes being replied to
+///
+/// We return all of this in a HashSet so that we can fetch these from
+/// remote relays.
+///
 fn get_unknown_note_ids<'a>(
     ndb: &Ndb,
     _cached_note: &CachedNote,