Skip to content

Commit 4f3f1db

Browse files
committed
f Include note on cardinality
1 parent 958c825 commit 4f3f1db

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

lightning/src/util/persist.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,12 @@ pub const SCORER_PERSISTENCE_KEY: &str = "scorer";
6565
/// Keys and namespaces are required to be valid ASCII strings in the range of
6666
/// [`KVSTORE_NAMESPACE_KEY_ALPHABET`] and no longer than 120 characters. Empty namespaces and
6767
/// sub-namespaces (`""`) are assumed to be a valid, however, if `namespace` is empty,
68-
/// `sub_namespace` is required to be empty, too. This means that concerns should always be separated by
69-
/// namespace first, before sub-namespaces are used. Note that per-namespace uniqueness needs to
70-
/// also hold for keys *and* namespaces/sub-namespaces in any given namespace/sub-namespace, i.e.,
71-
/// conflicts between keys and equally named namespaces/sub-namespaces must be avoided.
68+
/// `sub_namespace` is required to be empty, too. This means that concerns should always be
69+
/// separated by namespace first, before sub-namespaces are used. While the number of namespaces
70+
/// will be relatively small and is determined at compile time, there may be many sub-namespaces
71+
/// per namespace. Note that per-namespace uniqueness needs to also hold for keys *and*
72+
/// namespaces/sub-namespaces in any given namespace/sub-namespace, i.e., conflicts between keys
73+
/// and equally named namespaces/sub-namespaces must be avoided.
7274
///
7375
/// **Note:** Users migrating custom persistence backends from the pre-v0.0.117 `KVStorePersister`
7476
/// interface can use a concatenation of `[{namespace}/[{sub_namespace}/]]{key}` to recover a `key` compatible with the

0 commit comments

Comments
 (0)