move text grammar to the parser module

tormeh · Feb 8, 2023 · 3d4777a · 3d4777a
1 parent 514952c
commit 3d4777a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 13 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -271,19 +271,8 @@
 //! ## `Debug` and `Display`
 //!
 //! The `Debug` trait can be derived for a reasonable implementation. This library defines a standard
-//! text-based representation for flags that generated flags types can use. It uses the following
-//! whitespace and case insensitive grammar:
-//!
-//! - _Flags:_ (_Flag_)`|`*
-//! - _Flag:_ _Identifier_ | _HexNumber_
-//! - _Identifier:_ Any Rust identifier
-//! - _HexNumber_: `0x`([0-9a-zA-Z])*
-//!
-//! As an example, this is how `Flags::A | Flags::B | 0x0c` can be represented as text:
-//!
-//! ```text
-//! A | B | 0x0c
-//! ```
+//! text-based representation for flags that generated flags types can use. For details on the exact
+//! grammar, see the [`parser`] module.
 //!
 //! ## `PartialEq` and `PartialOrd`
 //!

diff --git a/src/parser.rs b/src/parser.rs
@@ -1,4 +1,18 @@
 //! Parsing flags from text.
+//!
+//! `bitflags` defines the following whitespace-insensitive grammar for flags formatted
+//! as text:
+//!
+//! - _Flags:_ (_Flag_)`|`*
+//! - _Flag:_ _Identifier_ | _HexNumber_
+//! - _Identifier:_ Any Rust identifier
+//! - _HexNumber_: `0x`([0-9a-zA-Z])*
+//!
+//! As an example, this is how `Flags::A | Flags::B | 0x0c` can be represented as text:
+//!
+//! ```text
+//! A | B | 0x0c
+//! ```
 
 use core::fmt;