rename set_yield_args to yield_with

Author: Your Name

src/error.rs

@@ -206,7 +206,7 @@ pub enum Error {
         /// Underlying error.
         cause: Arc<Error>,
     },
-    /// A special error variant that tells Rust to yield to Lua with the specified args
+    /// A special error variant that tells Rust to yield to Lua with the specified arguments
     Yield(MultiValue),
 }
 

src/state.rs

@@ -2146,10 +2146,29 @@ impl Lua {
         &*self.raw.data_ptr()
     }
 
-    /// Helper method to set the yield arguments, returning a Error::Yield.
+    /// Helper method to set the yield arguments, returning a ``Error::Yield``.
+    ///
+    /// Internally, this method is equivalent to ``Err(Error::Yield(args.into_lua_multi(self)?))``
     ///
     /// This method is mostly useful with continuations and Rust-Rust yields
     /// due to the Rust/Lua boundary
+    ///
+    /// Example:
+    ///
+    /// ```rust
+    /// fn test() -> mlua::Result<()> {
+    ///     let lua = mlua::Lua::new();
+    ///     let always_yield = lua.create_function(|lua, ()| lua.yield_with((42, "69420".to_string(), 45.6)))?;
+    ///
+    ///     let thread = lua.create_thread(always_yield)?;
+    ///     assert_eq!(
+    ///         thread.resume::<(i32, String, f32)>(())?,
+    ///         (42, String::from("69420"), 45.6)
+    ///     );
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn yield_with(&self, args: impl IntoLuaMulti) -> Result<()> {
         Err(Error::Yield(args.into_lua_multi(self)?))
     }

src/state/raw.rs

@@ -12,7 +12,9 @@ use crate::chunk::ChunkMode;
 use crate::error::{Error, Result};
 use crate::function::Function;
 use crate::memory::{MemoryState, ALLOCATOR};
-use crate::state::util::{callback_error_ext, callback_error_ext_yieldable, ref_stack_pop};
+#[allow(unused_imports)]
+use crate::state::util::callback_error_ext;
+use crate::state::util::{callback_error_ext_yieldable, ref_stack_pop};
 use crate::stdlib::StdLib;
 use crate::string::String;
 use crate::table::Table;