Makes README and lib doc 1:1 equivalent

Author: ElouanPetereau

README.md

@@ -122,7 +122,7 @@ for network parsing.
   zerocopy_derive::FromBytes`).
 
 - **`serde`**
-  Provides [`serde`](https://github.com/serde-rs/serde) `Serialize` and `Deserialize` impls for 
+  Provides [`serde`](https://github.com/serde-rs/serde) `Serialize` and `Deserialize` impls for
   the `byteorder` numeric wrappers by delegating to their underlying primitive types.
 
 - **`simd`**

src/lib.rs

@@ -121,18 +121,9 @@
 //!   derives as `use zerocopy_derive::*` rather than by name (e.g., `use
 //!   zerocopy_derive::FromBytes`).
 //!
-#![cfg_attr(
-    feature = "serde",
-    doc = " - **`serde`**
-Provides [`serde::Serialize`] and [`serde::Deserialize`] impls for the [`byteorder`] numeric
-wrappers by delegating to their underlying primitive types."
-)]
-#![cfg_attr(
-    not(feature = "serde"),
-    doc = " - **`serde`**
-Provides `serde` `Serialize` and `Deserialize` impls for the [`byteorder`] numeric
-wrappers by delegating to their underlying primitive types."
-)]
+//! - **`serde`**
+//!   Provides [`serde`](https://github.com/serde-rs/serde) `Serialize` and `Deserialize` impls for
+//!   the `byteorder` numeric wrappers by delegating to their underlying primitive types.
 //!
 //! - **`simd`**
 //!   When the `simd` feature is enabled, [`FromZeros`], [`FromBytes`], and

tools/generate-readme/src/main.rs

@@ -37,15 +37,23 @@ fn main() {
 
     let readme = String::from_utf8(output.stdout).unwrap();
 
-    // This regex is used to strip code links like:
+    // This regex is used to strip code links without url after, like:
     //
     //   /// Here is a link to [`Vec`].
     //
     // These links don't work in a Markdown file, and so we remove the `[` and `]`
     // characters to convert them to non-link code snippets.
-    let body = Regex::new(r"\[(`[^`]*`)\]")
-        .unwrap()
-        .replace_all(&readme, |caps: &Captures| caps[1].to_string());
+    let re = Regex::new(r"\[(`[^`]*`)\](\([^)]*\))?").unwrap();
+
+    let body = re.replace_all(&readme, |caps: &Captures| {
+        if caps.get(2).is_some() {
+            // There is a following `(...)`: keep the whole original text
+            caps[0].to_string()
+        } else {
+            // No `(...)`: strip the surrounding [ ]
+            caps[1].to_string()
+        }
+    });
 
     println!("{}\n\n{}\n{}", COPYRIGHT_HEADER, body, DISCLAIMER_FOOTER);
 }