Added warning for removal of deprecated functions in 0.16, removed some obsolete usage info for cancellable variants

Author: Andrew J Westlake

src/async_std.rs

@@ -211,6 +211,8 @@ where
 
 /// Convert a Rust Future into a Python awaitable
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -285,8 +287,10 @@ where
 /// Convert a Rust Future into a Python awaitable
 ///
 /// __This function was deprecated in favor of [`future_into_py_with_locals`] in `v0.15` because
-/// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
-/// replaced with [`future_into_py_with_locals`].__
+/// it became the default behaviour. In `v0.15`, any calls to this function should be replaced with
+/// [`future_into_py_with_locals`]__
+///
+/// __This function will be removed in `v0.16`__
 ///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
@@ -357,13 +361,12 @@ where
 
 /// Convert a Rust Future into a Python awaitable
 ///
-/// Unlike [`future_into_py`], this function will stop the Rust future from running when
-/// the `asyncio.Future` is cancelled from Python.
-///
 /// __This function was deprecated in favor of [`future_into_py`] in `v0.15` because
 /// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
 /// replaced with [`future_into_py`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
 /// * `fut` - The Rust future to be converted
@@ -399,6 +402,8 @@ where
 
 /// Convert a `!Send` Rust Future into a Python awaitable
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -507,9 +512,11 @@ where
 /// Convert a `!Send` Rust Future into a Python awaitable
 ///
 /// __This function was deprecated in favor of [`local_future_into_py_with_locals`] in `v0.15` because
-/// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
+/// it became the default behaviour. In `v0.15`, any calls to this function should be
 /// replaced with [`local_future_into_py_with_locals`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -609,13 +616,12 @@ where
 
 /// Convert a `!Send` Rust Future into a Python awaitable
 ///
-/// Unlike [`local_future_into_py`], this function will stop the Rust future from running when
-/// the `asyncio.Future` is cancelled from Python.
-///
 /// __This function was deprecated in favor of [`local_future_into_py`] in `v0.15` because
 /// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
 /// replaced with [`local_future_into_py`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
 /// * `fut` - The Rust future to be converted

src/generic.rs

@@ -580,7 +580,7 @@ where
 
 /// Convert a Rust Future into a Python awaitable with a generic runtime
 ///
-/// __
+/// __This function will be removed in `v0.16`__
 ///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
@@ -764,7 +764,7 @@ impl PyDoneCallback {
 /// Convert a Rust Future into a Python awaitable with a generic runtime
 ///
 /// __This function was deprecated in favor of [`future_into_py_with_locals`] in `v0.15` because
-/// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
+/// it became the default behaviour. In `v0.15`, any calls to this function should be
 /// replaced with [`future_into_py_with_locals`].__
 ///
 /// __In `v0.16` this function will be removed__
@@ -1345,9 +1345,11 @@ where
 /// Convert a `!Send` Rust Future into a Python awaitable with a generic runtime
 ///
 /// __This function was deprecated in favor of [`local_future_into_py_with_locals`] in `v0.15` because
-/// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
+/// it became the default behaviour. In `v0.15`, any calls to this function should be
 /// replaced with [`local_future_into_py_with_locals`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -1564,13 +1566,12 @@ where
 }
 /// Convert a Rust Future into a Python awaitable with a generic runtime
 ///
-/// Unlike [`local_future_into_py`], this function will stop the Rust future from running when the
-/// `asyncio.Future` is cancelled from Python.
-///
 /// __This function was deprecated in favor of [`local_future_into_py`] in `v0.15` because
 /// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
 /// replaced with [`local_future_into_py`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
 /// * `fut` - The Rust future to be converted

src/lib.rs

@@ -562,7 +562,7 @@ fn call_soon_threadsafe(
 /// simply awaits the result through the `futures::channel::oneshot::Receiver<PyResult<PyObject>>`.
 ///
 /// # Arguments
-/// * `event_loop` - The Python event loop that the awaitable should be attached to
+/// * `locals` - The Python event loop and context to be used for the provided awaitable
 /// * `awaitable` - The Python `awaitable` to be converted
 ///
 /// # Examples
@@ -639,6 +639,8 @@ pub fn into_future_with_locals(
 /// `futures::channel::oneshot::Sender<PyResult<PyObject>>` and the future returned by this function
 /// simply awaits the result through the `futures::channel::oneshot::Receiver<PyResult<PyObject>>`.
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `awaitable` - The Python `awaitable` to be converted

src/tokio.rs

@@ -228,6 +228,8 @@ where
 
 /// Convert a Rust Future into a Python awaitable
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -302,9 +304,11 @@ where
 /// Convert a Rust Future into a Python awaitable
 ///
 /// __This function was deprecated in favor of [`future_into_py_with_locals`] in `v0.15` because
-/// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
+/// it became the default behaviour. In `v0.15`, any calls to this function should be
 /// replaced with [`future_into_py_with_locals`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -374,13 +378,12 @@ where
 
 /// Convert a Rust Future into a Python awaitable
 ///
-/// Unlike [`future_into_py`], this function will stop the Rust future from running when
-/// the `asyncio.Future` is cancelled from Python.
-///
 /// __This function was deprecated in favor of [`future_into_py`] in `v0.15` because
 /// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
 /// replaced with [`future_into_py`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
 /// * `fut` - The Rust future to be converted
@@ -416,6 +419,8 @@ where
 
 /// Convert a `!Send` Rust Future into a Python awaitable
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -556,9 +561,11 @@ where
 /// Convert a `!Send` Rust Future into a Python awaitable
 ///
 /// __This function was deprecated in favor of [`local_future_into_py_with_locals`] in `v0.15` because
-/// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
+/// it became the default behaviour. In `v0.15`, any calls to this function should be
 /// replaced with [`local_future_into_py_with_locals`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `event_loop` - The Python event loop that the awaitable should be attached to
 /// * `fut` - The Rust future to be converted
@@ -692,13 +699,12 @@ where
 
 /// Convert a `!Send` Rust Future into a Python awaitable
 ///
-/// Unlike [`local_future_into_py`], this function will stop the Rust future from running when
-/// the `asyncio.Future` is cancelled from Python.
-///
 /// __This function was deprecated in favor of [`local_future_into_py`] in `v0.15` because
 /// it became the default behaviour. In `v0.15`, any calls to this function can be seamlessly
 /// replaced with [`local_future_into_py`].__
 ///
+/// __This function will be removed in `v0.16`__
+///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
 /// * `fut` - The Rust future to be converted