Add clarifications to the schemas doc-comments

avocadocoder73 · Mar 28, 2022 · 8cb776a · 8cb776a
1 parent 8fa9785
commit 8cb776a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/core/lib/storage/src/chain/tree_cache/bincode_schema.rs b/core/lib/storage/src/chain/tree_cache/bincode_schema.rs
@@ -8,6 +8,8 @@ use super::records::AccountTreeCache;
 use crate::{QueryResult, StorageProcessor};
 
 /// Tree cache schema contains methods to store/load Merkle tree cache.
+///
+/// This schema is used to interact with caches encoded as *binary* data (using `bincode` protocol).
 #[derive(Debug)]
 pub struct TreeCacheSchemaBincode<'a, 'c>(pub &'a mut StorageProcessor<'c>);
 

diff --git a/core/lib/storage/src/chain/tree_cache/json_schema.rs b/core/lib/storage/src/chain/tree_cache/json_schema.rs
@@ -8,6 +8,8 @@ use super::records::AccountTreeCache;
 use crate::{QueryResult, StorageProcessor};
 
 /// Tree cache schema contains methods to store/load Merkle tree cache.
+///
+/// This schema is used to interact with caches encoded as *JSON* data.
 #[derive(Debug)]
 pub struct TreeCacheSchemaJSON<'a, 'c>(pub &'a mut StorageProcessor<'c>);