Use 'doc_cfg' only when building docs.

Resolves #177.
rwf2 · Jul 14, 2021 · 4d1ede6 · 4d1ede6
1 parent 97fd2b6
commit 4d1ede6
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/src/jar.rs b/src/jar.rs
@@ -410,7 +410,7 @@ impl CookieJar {
     /// assert!(jar.get("private").is_some());
     /// ```
     #[cfg(feature = "private")]
-    #[cfg_attr(nightly, doc(cfg(feature = "private")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "private")))]
     pub fn private<'a>(&'a self, key: &Key) -> PrivateJar<&'a Self> {
         PrivateJar::new(self, key)
     }
@@ -438,7 +438,7 @@ impl CookieJar {
     /// jar.private_mut(&key).remove(Cookie::named("private"));
     /// ```
     #[cfg(feature = "private")]
-    #[cfg_attr(nightly, doc(cfg(feature = "private")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "private")))]
     pub fn private_mut<'a>(&'a mut self, key: &Key) -> PrivateJar<&'a mut Self> {
         PrivateJar::new(self, key)
     }
@@ -473,7 +473,7 @@ impl CookieJar {
     /// assert!(jar.get("signed").is_some());
     /// ```
     #[cfg(feature = "signed")]
-    #[cfg_attr(nightly, doc(cfg(feature = "signed")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "signed")))]
     pub fn signed<'a>(&'a self, key: &Key) -> SignedJar<&'a Self> {
         SignedJar::new(self, key)
     }
@@ -500,7 +500,7 @@ impl CookieJar {
     /// jar.signed_mut(&key).remove(Cookie::named("signed"));
     /// ```
     #[cfg(feature = "signed")]
-    #[cfg_attr(nightly, doc(cfg(feature = "signed")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "signed")))]
     pub fn signed_mut<'a>(&'a mut self, key: &Key) -> SignedJar<&'a mut Self> {
         SignedJar::new(self, key)
     }

diff --git a/src/lib.rs b/src/lib.rs
@@ -74,7 +74,7 @@
 //! features = ["secure", "percent-encode"]
 //! ```
 
-#![cfg_attr(nightly, feature(doc_cfg))]
+#![cfg_attr(all(nightly, doc), feature(doc_cfg))]
 
 #![doc(html_root_url = "https://docs.rs/cookie/0.15")]
 #![deny(missing_docs)]
@@ -308,7 +308,7 @@ impl<'c> Cookie<'c> {
     /// assert_eq!(c.http_only(), Some(true));
     /// ```
     #[cfg(feature = "percent-encode")]
-    #[cfg_attr(nightly, doc(cfg(feature = "percent-encode")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "percent-encode")))]
     pub fn parse_encoded<S>(s: S) -> Result<Cookie<'c>, ParseError>
         where S: Into<Cow<'c, str>>
     {
@@ -1095,7 +1095,7 @@ impl<'c> Cookie<'c> {
     /// assert_eq!(&c.encoded().stripped().to_string(), "my%20name=this%3B%20value%3F");
     /// ```
     #[cfg(feature = "percent-encode")]
-    #[cfg_attr(nightly, doc(cfg(feature = "percent-encode")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "percent-encode")))]
     #[inline(always)]
     pub fn encoded<'a>(&'a self) -> Display<'a, 'c> {
         Display::new_encoded(self)
@@ -1214,7 +1214,7 @@ impl<'a, 'c> Display<'a, 'c> {
     /// Percent-encode the name and value pair.
     #[inline]
     #[cfg(feature = "percent-encode")]
-    #[cfg_attr(nightly, doc(cfg(feature = "percent-encode")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "percent-encode")))]
     pub fn encoded(mut self) -> Self {
         self.encode = true;
         self

diff --git a/src/secure/key.rs b/src/secure/key.rs
@@ -14,7 +14,7 @@ const_assert!(crate::secure::private::KEY_LEN == ENCRYPTION_KEY_LEN);
 /// [`PrivateJar`](crate::PrivateJar) and [`SignedJar`](crate::SignedJar). A
 /// single instance of a `Key` can be used for both a `PrivateJar` and a
 /// `SignedJar` simultaneously with no notable security implications.
-#[cfg_attr(nightly, doc(cfg(any(feature = "private", feature = "signed"))))]
+#[cfg_attr(all(nightly, doc), doc(cfg(any(feature = "private", feature = "signed"))))]
 #[derive(Clone)]
 pub struct Key([u8; COMBINED_KEY_LENGTH /* SIGNING | ENCRYPTION */]);
 
@@ -86,7 +86,7 @@ impl Key {
     /// let key = Key::derive_from(master_key);
     /// ```
     #[cfg(feature = "key-expansion")]
-    #[cfg_attr(nightly, doc(cfg(feature = "key-expansion")))]
+    #[cfg_attr(all(nightly, doc), doc(cfg(feature = "key-expansion")))]
     pub fn derive_from(master_key: &[u8]) -> Self {
         if master_key.len() < 32 {
             panic!("bad master key length: expected >= 32 bytes, found {}", master_key.len());

diff --git a/src/secure/private.rs b/src/secure/private.rs
@@ -23,7 +23,7 @@ pub(crate) const KEY_LEN: usize = 32;
 /// `PrivateJar` are simultaneously assured confidentiality, integrity, and
 /// authenticity. In other words, clients cannot discover nor tamper with the
 /// contents of a cookie, nor can they fabricate cookie data.
-#[cfg_attr(nightly, doc(cfg(feature = "private")))]
+#[cfg_attr(all(nightly, doc), doc(cfg(feature = "private")))]
 pub struct PrivateJar<J> {
     parent: J,
     key: [u8; KEY_LEN]

diff --git a/src/secure/signed.rs b/src/secure/signed.rs
@@ -19,7 +19,7 @@ pub(crate) const KEY_LEN: usize = 32;
 /// integrity and authenticity. In other words, clients cannot tamper with the
 /// contents of a cookie nor can they fabricate cookie values, but the data is
 /// visible in plaintext.
-#[cfg_attr(nightly, doc(cfg(feature = "signed")))]
+#[cfg_attr(all(nightly, doc), doc(cfg(feature = "signed")))]
 pub struct SignedJar<J> {
     parent: J,
     key: [u8; KEY_LEN],