Update String::to_string_lossy doc

mlua-rs · Nov 9, 2024 · 958abd0 · 958abd0
1 parent 92a8203
commit 958abd0
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/string.rs b/src/string.rs
@@ -55,7 +55,11 @@ impl String {
     ///
     /// Any non-Unicode sequences are replaced with [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
     ///
+    /// This method returns [`StdString`] instead of [`Cow<'_, str>`] because lifetime cannot be
+    /// bound to a weak Lua object.
+    ///
     /// [U+FFFD]: std::char::REPLACEMENT_CHARACTER
+    /// [`Cow<'_, str>`]: std::borrow::Cow
     ///
     /// # Examples
     ///