From 405555b4015635cfb57795108ff18a8d534101d7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Lecrenier?= <loic@meilisearch.com>
Date: Wed, 17 Aug 2022 12:21:05 +0200
Subject: [PATCH] Add some documentation to PrefixTrieNode

---
 .../word_prefix_pair_proximity_docids.rs      | 22 +++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/milli/src/update/word_prefix_pair_proximity_docids.rs b/milli/src/update/word_prefix_pair_proximity_docids.rs
index e8d63acbb..367fdc7ab 100644
--- a/milli/src/update/word_prefix_pair_proximity_docids.rs
+++ b/milli/src/update/word_prefix_pair_proximity_docids.rs
@@ -576,6 +576,28 @@ pub fn write_into_lmdb_database_without_merging(
     Ok(())
 }
 
+/** A prefix trie. Used to iterate quickly over the prefixes of a word that are
+within a set.
+
+## Structure
+The trie is made of nodes composed of:
+1. a byte character (e.g. 'a')
+2. whether the node is an end node or not
+3. a list of children nodes, sorted by their byte character
+
+For example, the trie that stores the strings `[ac, ae, ar, ch, cei, cel, ch, r, rel, ri]`
+is drawn below. Nodes with a double border are "end nodes".
+
+┌──────────────────────┐ ┌──────────────────────┐ ╔══════════════════════╗
+│          a           │ │          c           │ ║          r           ║
+└──────────────────────┘ └──────────────────────┘ ╚══════════════════════╝
+╔══════╗╔══════╗╔══════╗ ┌─────────┐  ╔═════════╗ ┌─────────┐ ╔══════════╗
+║  c   ║║  e   ║║  r   ║ │    e    │  ║    h    ║ │    e    │ ║    i     ║
+╚══════╝╚══════╝╚══════╝ └─────────┘  ╚═════════╝ └─────────┘ ╚══════════╝
+                         ╔═══╗ ╔═══╗                 ╔═══╗
+                         ║ i ║ ║ l ║                 ║ l ║
+                         ╚═══╝ ╚═══╝                 ╚═══╝
+*/
 #[derive(Default, Debug)]
 struct PrefixTrieNode {
     children: Vec<(PrefixTrieNode, u8)>,