From e1c425fb44daaddb3a8ce6fc5cbf42682d8130b7 Mon Sep 17 00:00:00 2001 From: KodrAus Date: Wed, 5 Feb 2025 20:30:36 +1000 Subject: [PATCH] fix up a few docs --- Cargo.toml | 6 ++++++ macros/src/lib.rs | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 576cf13..b2f1376 100644 --- 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 index 47e2e1e..6840379 100644 --- 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)]