Merge pull request #48 from asomers/more-ci2

Misc development improvements
asomers · Nov 19, 2021 · 27b60a8 · 27b60a8
2 parents 7c9addc + 813ff5b
commit 27b60a8
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 17 deletions.
diff --git a/.cirrus.yml b/.cirrus.yml
@@ -1,5 +1,7 @@
 test_task:
   name: cargo test 
+  env:
+    RUSTDOCFLAGS: -D warnings
   matrix:
     - container:
        image: rust:1.45.0

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "futures-locks"
 edition = "2018"
-version = "0.6.1-pre"
+version = "0.6.0"
 authors = ["Alan Somers <asomers@gmail.com>"]
 license = "MIT/Apache-2.0"
 readme = "README.md"
@@ -15,13 +15,12 @@ autotests = false
 include = ["src/**/*", "LICENSE-*", "README.md", "CHANGELOG.md"]
 
 [package.metadata.docs.rs]
-features = ["tokio", "nightly-docs"]
+features = ["tokio"]
+rustdoc-args = ["--cfg", "docsrs"]
 
 [features]
 # Enable methods that require a Tokio runtime.
 default = ["tokio"]
-# For building documentation only; no functional change to the library.
-nightly-docs = []
 
 [dependencies]
 futures-channel = "0.3.1"

diff --git a/src/lib.rs b/src/lib.rs
@@ -25,7 +25,8 @@
 //! [`Futures`]: https://github.com/rust-lang-nursery/futures-rs
 //! [`Tokio`]: https:/tokio.rs
 
-#![cfg_attr(feature = "nightly-docs", feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![warn(missing_docs)]
 
 mod mutex;
 mod rwlock;

diff --git a/src/mutex.rs b/src/mutex.rs
@@ -363,8 +363,8 @@ impl<T: 'static + ?Sized> Mutex<T> {
     /// assert_eq!(mtx.try_unwrap().unwrap(), 5);
     /// # }
     /// ```
-    #[cfg(any(feature = "tokio", all(feature = "nightly-docs", rustdoc)))]
-    #[cfg_attr(feature = "nightly-docs", doc(cfg(feature = "tokio")))]
+    #[cfg(any(feature = "tokio", all(docsrs, rustdoc)))]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub fn with<B, F, R>(&self, f: F)
         -> impl Future<Output = R>
         where F: FnOnce(MutexGuard<T>) -> B + Send + 'static,
@@ -403,8 +403,8 @@ impl<T: 'static + ?Sized> Mutex<T> {
     /// assert_eq!(*mtx.try_unwrap().unwrap(), 5);
     /// # }
     /// ```
-    #[cfg(any(feature = "tokio", all(feature = "nightly-docs", rustdoc)))]
-    #[cfg_attr(feature = "nightly-docs", doc(cfg(feature = "tokio")))]
+    #[cfg(any(feature = "tokio", all(docsrs, rustdoc)))]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub fn with_local<B, F, R>(&self, f: F)
         -> impl Future<Output = R>
         where F: FnOnce(MutexGuard<T>) -> B + 'static,

diff --git a/src/rwlock.rs b/src/rwlock.rs
@@ -501,8 +501,8 @@ impl<T: 'static + ?Sized> RwLock<T> {
     /// assert_eq!(r, 5);
     /// # }
     /// ```
-    #[cfg(any(feature = "tokio", all(feature = "nightly-docs", rustdoc)))]
-    #[cfg_attr(feature = "nightly-docs", doc(cfg(feature = "tokio")))]
+    #[cfg(any(feature = "tokio", all(docsrs, rustdoc)))]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub fn with_read<B, F, R>(&self, f: F)
         -> impl Future<Output = R>
         where F: FnOnce(RwLockReadGuard<T>) -> B + Send + 'static,
@@ -541,8 +541,8 @@ impl<T: 'static + ?Sized> RwLock<T> {
     /// assert_eq!(r, 5);
     /// # }
     /// ```
-    #[cfg(any(feature = "tokio", all(feature = "nightly-docs", rustdoc)))]
-    #[cfg_attr(feature = "nightly-docs", doc(cfg(feature = "tokio")))]
+    #[cfg(any(feature = "tokio", all(docsrs, rustdoc)))]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub fn with_read_local<B, F, R>(&self, f: F)
         -> impl Future<Output = R>
         where F: FnOnce(RwLockReadGuard<T>) -> B + 'static + Unpin,
@@ -591,8 +591,8 @@ impl<T: 'static + ?Sized> RwLock<T> {
     /// assert_eq!(rwlock.try_unwrap().unwrap(), 5);
     /// # }
     /// ```
-    #[cfg(any(feature = "tokio", all(feature = "nightly-docs", rustdoc)))]
-    #[cfg_attr(feature = "nightly-docs", doc(cfg(feature = "tokio")))]
+    #[cfg(any(feature = "tokio", all(docsrs, rustdoc)))]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub fn with_write<B, F, R>(&self, f: F)
         -> impl Future<Output = R>
         where F: FnOnce(RwLockWriteGuard<T>) -> B + Send + 'static,
@@ -632,8 +632,8 @@ impl<T: 'static + ?Sized> RwLock<T> {
     /// assert_eq!(*rwlock.try_unwrap().unwrap(), 5);
     /// # }
     /// ```
-    #[cfg(any(feature = "tokio", all(feature = "nightly-docs", rustdoc)))]
-    #[cfg_attr(feature = "nightly-docs", doc(cfg(feature = "tokio")))]
+    #[cfg(any(feature = "tokio", all(docsrs, rustdoc)))]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
     pub fn with_write_local<B, F, R>(&self, f: F)
         -> impl Future<Output = R>
         where F: FnOnce(RwLockWriteGuard<T>) -> B + 'static + Unpin,