add deprecation notice

zingolabs · Jan 27, 2025 · 7b9aa71 · 7b9aa71
1 parent b393ae9
commit 7b9aa71
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/zingo-status/Cargo.toml b/zingo-status/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zingo-status"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 
 [dependencies]

diff --git a/zingo-status/src/confirmation_status.rs b/zingo-status/src/confirmation_status.rs
@@ -194,7 +194,6 @@ impl ConfirmationStatus {
         }
     }
 
-    /// Because the value inside the ConfirmationStatus means different things depending on the case, this function is poorly quantified and can lead to unexpected behavior.
     /// Please use a match statement and be careful handling each case.
     /// # Examples
     ///
@@ -205,7 +204,11 @@ impl ConfirmationStatus {
     /// let status = ConfirmationStatus::Confirmed(15.into());
     /// assert_eq!(status.get_height(), 15.into());
     /// ```
-    pub(crate) fn get_height(&self) -> BlockHeight {
+    #[deprecated(
+        note = "Because the value inside the ConfirmationStatus means different things depending on the case, this function is poorly quantified and can lead to unexpected behavior.",
+        since = "0.1.1"
+    )]
+    pub fn get_height(&self) -> BlockHeight {
         match self {
             Self::Calculated(self_height) => *self_height,
             Self::Mempool(self_height) => *self_height,