Fixed some documentation

Author: Andrew J Westlake

README.md

@@ -24,7 +24,7 @@ pyo3 = { git = "https://github.com/PyO3/pyo3" }
 
 ## Quickstart
 
-Here we initialize the runtime, import Python's `asyncio` library and run the given future to completion using Python's default `EventLoop` and Tokio. Inside the future, we convert `asyncio` sleep into a Rust future and await it.
+Here we initialize the runtime, import Python's `asyncio` library and run the given future to completion using Python's default `EventLoop` and `async-std`. Inside the future, we convert `asyncio` sleep into a Rust future and await it.
 
 More details on the usage of this library can be found in the [API docs](https://awestlake87.github.io/pyo3-asyncio/master/doc).
 

src/async_std.rs

@@ -17,7 +17,6 @@
 //!
 //! `pytests/test_example.rs`
 //! ```no_run
-//!
 //! fn main() {
 //!
 //! }
@@ -96,7 +95,7 @@ use crate::{get_event_loop, CALL_SOON, CREATE_FUTURE, EXPECT_INIT};
 /// The event loop runs until the given future is complete.
 ///
 /// After this function returns, the event loop can be resumed with either [`run_until_complete`] or
-/// [`run_forever`]
+/// [`crate::run_forever`]
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -265,6 +264,7 @@ where
     Ok(future_rx)
 }
 
+/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>testing</code></span> Testing Utilities for the async-std runtime.
 #[cfg(feature = "testing")]
 pub mod testing {
     use async_std::task;

src/lib.rs

@@ -18,8 +18,8 @@
 //! be run on the same event loop.
 //!
 //! It's not immediately clear that this would provide worthwhile performance wins either, so in the
-//! interest of keeping things simple, this crate runs both event loops independently and handles
-//! the communication between them.
+//! interest of keeping things simple, this crate creates and manages the Python event loop and
+//! handles the communication between separate Rust event loops.
 //!
 //! ## Python's Event Loop
 //!
@@ -30,9 +30,7 @@
 //!
 //! ## Rust's Event Loop
 //!
-//! Currently only the Tokio runtime is supported by this crate. Tokio makes it easy to construct
-//! and maintain a runtime that runs on background threads only and it provides a single threaded
-//! scheduler to make it easier to work around Python's GIL.
+//! Currently only the async-std and Tokio runtimes are supported by this crate.
 //!
 //! > _In the future, more runtimes may be supported for Rust._
 //!
@@ -42,6 +40,32 @@
 //! <span
 //!   class="module-item stab portability"
 //!   style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"
+//! ><code>async-std-runtime</code></span>
+//! are only available when the `async-std-runtime` Cargo feature is enabled:
+//!
+//! ```toml
+//! [dependencies.pyo3-asyncio]
+//! version = "0.13.0"
+//! features = ["async-std-runtime"]
+//! ```
+//!
+//! Items marked with
+//! <span
+//!   class="module-item stab portability"
+//!   style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"
+//! ><code>tokio-runtime</code></span>
+//! are only available when the `tokio-runtime` Cargo feature is enabled:
+//!
+//! ```toml
+//! [dependencies.pyo3-asyncio]
+//! version = "0.13.0"
+//! features = ["tokio-runtime"]
+//! ```
+//!
+//! Items marked with
+//! <span
+//!   class="module-item stab portability"
+//!   style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"
 //! ><code>testing</code></span>
 //! are only available when the `testing` Cargo feature is enabled:
 //!
@@ -56,10 +80,12 @@
 #[doc(inline)]
 pub mod testing;
 
+/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>async-std-runtime</code></span> PyO3 Asyncio functions specific to the async-std runtime
 #[cfg(feature = "async-std")]
 #[doc(inline)]
 pub mod async_std;
 
+/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>tokio-runtime</code></span> PyO3 Asyncio functions specific to the tokio runtime
 #[cfg(feature = "tokio-runtime")]
 #[doc(inline)]
 pub mod tokio;
@@ -172,11 +198,11 @@ pub fn get_event_loop(py: Python) -> &PyAny {
 
 /// Run the event loop forever
 ///
-/// This can be called instead of [`run_until_complete`] to run the event loop
+/// This can be called instead of `run_until_complete` to run the event loop
 /// until `stop` is called rather than driving a future to completion.
 ///
-/// After this function returns, the event loop can be resumed with either [`run_until_complete`] or
-/// [`run_forever`]
+/// After this function returns, the event loop can be resumed with either `run_until_complete` or
+/// [`crate::run_forever`]
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard

src/tokio.rs

@@ -17,7 +17,6 @@
 //!
 //! `pytests/test_example.rs`
 //! ```no_run
-//!
 //! fn main() {
 //!
 //! }
@@ -129,7 +128,7 @@ use crate::{get_event_loop, CALL_SOON, CREATE_FUTURE, EXPECT_INIT};
 /// The event loop runs until the given future is complete.
 ///
 /// After this function returns, the event loop can be resumed with either [`run_until_complete`] or
-/// [`run_forever`]
+/// [`crate::run_forever`]
 ///
 /// # Arguments
 /// * `py` - The current PyO3 GIL guard
@@ -315,6 +314,7 @@ where
     Ok(future_rx)
 }
 
+/// <span class="module-item stab portability" style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"><code>testing</code></span> Testing Utilities for the Tokio runtime.
 #[cfg(feature = "testing")]
 pub mod testing {
     use ::tokio::runtime::Runtime;