Merge pull request #1 from bitflags/chore/doc-fixes

Fix up a few docs
bitflags · Feb 5, 2025 · 8b3cff9 · 8b3cff9
2 parents 94b077e + e1c425f
commit 8b3cff9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -18,6 +18,12 @@ version = "0.0.1"
 [dependencies.bitflags]
 version = "2"
 
+# Adding new library support to `bitflags-derive`:
+#
+# 1. Add an optional dependency here
+# 2. Add support in a module in `macros`
+# 3. Add some tests in `tests/ui`
+
 [workspace]
 members = [
     "macros",

diff --git a/macros/src/lib.rs b/macros/src/lib.rs
@@ -16,7 +16,7 @@ mod debug;
 /**
 Derive [`Debug`](https://doc.rust-lang.org/std/fmt/trait.Debug.html) for a flags type.
 
-This macro will use [`https://docs.rs/bitflags/latest/bitflags/parser/fn.to_writer.html`] to
+This macro will use [`to_writer`](https://docs.rs/bitflags/latest/bitflags/parser/fn.to_writer.html) to
 format flags values.
 */
 #[proc_macro_derive(FlagsDebug)]