more docs

README.md

@@ -27,7 +27,7 @@
   - [Getters](#getters)
 - [🛠️ Properties](#️-properties)
   - [Immutable](#immutable)
-  - [Thread safe](#thread-safe)
+  - [Stack safe](#stack-safe)
   - [(Space) Efficient](#space-efficient)
 - [📃 Versioning](#-versioning)
 - [😀 Support](#-support)
@@ -121,7 +121,7 @@ expect(newITrie.length, 1);
 
 > ✅ Immutability in `ITrie` uses a technique called **Path copying**: this makes `ITrie` efficient since it does not require to copy the full data structure with every mutation 
 
-### Thread safe
+### Stack safe
 `ITrie` does **not** use recursion. No matter how many operations or elements it contains, `ITrie` will never cause stack overflow issues.
 
 ### (Space) Efficient

lib/src/itrie_base.dart

@@ -1,8 +1,3 @@
-/// {@template immutable_notice}
-/// [ITrie] is immutable: this method returns a copy of the original
-/// [ITrie] without modifying the original [ITrie]
-/// {@endtemplate}
-
 class _Node<V> {
   final String key;
   V? value;
@@ -92,6 +87,13 @@ class _ITrieIterator<V> implements Iterator<(String, V)> {
   }
 }
 
+/// [ITrie] is used for locating specific string keys from within a set.
+///
+/// [ITrie] is often used to store a dictionary (list of words) that can be searched
+/// in a manner that allows for efficient generation of completion lists
+/// (e.g. predict the rest of a word a user is typing).
+///
+/// [ITrie] is **efficient, immutable and stack safe**.
 class ITrie<V> extends Iterable<(String, V)> {
   final _Node<V>? _root;
   final int _count;
@@ -121,7 +123,10 @@ class ITrie<V> extends Iterable<(String, V)> {
   ///
   /// If `key` is already present its previous value is overwritten with `value`
   ///
-  /// {@macro immutable_notice}
+  /// {@template immutable_notice}
+  /// [ITrie] is immutable: this method returns a copy of the original
+  /// [ITrie] without modifying the original [ITrie]
+  /// {@endtemplate}
   ///
   /// {@category Mutation}
   ITrie<V> insert(String key, V value) {