fix docs and increase version

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "iroh-io"
-version = "0.2.2"
+version = "0.3.0"
 edition = "2021"
 license = "Apache-2.0 OR MIT"
 authors = ["rklaehn <[email protected]>", "n0 team"]
@@ -22,7 +22,10 @@ tokio-util = { version = "0.7", default-features = false, optional = true }
 http = ["reqwest"]
 tokio-io = ["tokio", "smallvec"]
 stats = []
-default = ["tokio-io", "stats"]
+default = ["tokio-io"]
+
+[package.metadata.docs.rs]
+features = ["http", "tokio-io", "stats"]
 
 [dev-dependencies]
 axum = { version = "0.6" }

src/lib.rs

@@ -32,8 +32,8 @@
 //! always get a new reader. Also, if you need concurrent access to the same resource,
 //! create multiple readers.
 //!
-//! One thing you might wonder is why there are separate methods for writing Bytes and writing slices.
-//! The reason is that if you already have Bytes and the underlying writer needs Bytes, you can avoid
+//! One thing you might wonder is why there are separate methods for writing [Bytes] and writing slices.
+//! The reason is that if you already have [Bytes] and the underlying writer needs [Bytes], you can avoid
 //! an allocation.
 #![deny(missing_docs, rustdoc::broken_intra_doc_links)]
 

src/tokio_io.rs

@@ -397,7 +397,7 @@ mod tokio_helper {
 
     use super::*;
 
-    /// Future returned by [write].
+    /// Future that writes a slice to a writer
     #[derive(Debug)]
     #[must_use = "futures do nothing unless you `.await` or poll them"]
     #[pin_project]
@@ -443,7 +443,7 @@ mod tokio_helper {
         }
     }
 
-    /// Future returned by [write].
+    /// Future that writes Bytes to a writer
     #[derive(Debug)]
     #[must_use = "futures do nothing unless you `.await` or poll them"]
     #[pin_project]
@@ -487,7 +487,7 @@ mod tokio_helper {
         }
     }
 
-    /// Future for [TokioWrapper::flush].
+    /// Future that flushes a writer
     #[derive(Debug)]
     #[must_use = "futures do nothing unless you `.await` or poll them"]
     #[pin_project]