Add note about decoding to into_combining_chars

JSorngard · Jan 14, 2024 · ce9da41 · ce9da41
1 parent b043e6e
commit ce9da41
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/common/src/zalgo_string/mod.rs b/common/src/zalgo_string/mod.rs
@@ -464,6 +464,9 @@ impl ZalgoString {
     /// of the string down one index.
     ///
     /// It is the same as calling [`ZalgoString::into_string()`] followed by [`String::remove(0)`](String::remove).
+    /// 
+    /// Just like [`as_combining_chars`](ZalgoString::as_combining_chars) the result of this method can not
+    /// be decoded by [`zalgo_decode`].
     ///
     /// # Example
     ///