docs: marke merkle_reg() accessors as unstable (in comment) on Regist…

…er types
maidsafe · Feb 19, 2024 · cf58272 · cf58272
1 parent 73c1e86
commit cf58272
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/sn_client/src/register.rs b/sn_client/src/register.rs
@@ -284,6 +284,7 @@ impl ClientRegister {
     }
 
     /// Access the underlying MerkleReg (e.g. for access to history)
+    /// NOTE: This API is unstable and may be removed in the future
     pub fn merkle_reg(&self) -> &MerkleReg<Entry> {
         self.register.merkle_reg()
     }

diff --git a/sn_registers/src/reg_crdt.rs b/sn_registers/src/reg_crdt.rs
@@ -114,6 +114,7 @@ impl RegisterCrdt {
     }
 
     /// Access the underlying MerkleReg (e.g. for access to history)
+    /// NOTE: This API is unstable and may be removed in the future
     pub(crate) fn merkle_reg(&self) -> &MerkleReg<Entry> {
         &self.data
     }

diff --git a/sn_registers/src/register.rs b/sn_registers/src/register.rs
@@ -131,6 +131,7 @@ impl SignedRegister {
     }
 
     /// Access the underlying MerkleReg (e.g. for access to history)
+    /// NOTE: This API is unstable and may be removed in the future
     pub fn merkle_reg(&self) -> &MerkleReg<Entry> {
         self.base_register.merkle_reg()
     }
@@ -261,6 +262,7 @@ impl Register {
     }
 
     /// Access the underlying MerkleReg (e.g. for access to history)
+    /// NOTE: This API is unstable and may be removed in the future
     pub fn merkle_reg(&self) -> &MerkleReg<Entry> {
         self.crdt.merkle_reg()
     }