Merge pull request #597 from k-nasa/fix_doc_test

Fix failed doc test and enable doc test on CI

Author: yoshuawuyts

.github/workflows/ci.yml

@@ -63,7 +63,13 @@ jobs:
       uses: actions-rs/cargo@v1
       with:
         command: test
-        args: --all --features unstable attributes
+        args: --all --features "unstable attributes"
+
+    - name: documentation test
+      uses: actions-rs/cargo@v1
+      with:
+        command: test
+        args: --doc --features "unstable attributes"
 
   check_fmt_and_docs:
     name: Checking fmt and docs

src/lib.rs

@@ -152,6 +152,8 @@
 //! Await two futures concurrently, and return a tuple of their output:
 //!
 //! ```
+//! use async_std::prelude::*;
+//!
 //! #[async_std::main]
 //! async fn main() {
 //!     let a = async { 1u8 };
@@ -167,7 +169,7 @@
 //!
 //! #[async_std::main]
 //! async fn main() -> std::io::Result<()> {
-//!     let mut socket = UdpSocket::bind("127.0.0.1:8080")?;
+//!     let socket = UdpSocket::bind("127.0.0.1:8080").await?;
 //!     println!("Listening on {}", socket.local_addr()?);
 //!
 //!     let mut buf = vec![0u8; 1024];

src/stream/stream/mod.rs

@@ -350,7 +350,7 @@ extension_trait! {
             assert!(start.elapsed().as_millis() >= 15);
 
             s.next().await;
-            assert!(start.elapsed().as_millis() >= 35);
+            assert!(start.elapsed().as_millis() >= 25);
             #
             # }) }
             ```

tests/verbose_errors.rs

@@ -8,7 +8,7 @@ fn open_file() {
         match res {
             Ok(_) => panic!("Found file with random name: We live in a simulation"),
             Err(e) => assert_eq!(
-                "Could not open `/ashjudlkahasdasdsikdhajik/asdasdasdasdasdasd/fjuiklashdbflasas`",
+                "could not open `/ashjudlkahasdasdsikdhajik/asdasdasdasdasdasd/fjuiklashdbflasas`",
                 &format!("{}", e)
             ),
         }