Fix formatting inconsistencies in documentation comments and README (#…

…163)
SRv6d · Dec 24, 2024 · abd2e54 · abd2e54
1 parent 87489ed
commit abd2e54
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -103,13 +103,13 @@ Object(
 instead of copying them.
 
 ```text
-role:           ACME Company ◀─────────────── &"role"    ───  &"ACME Company"
-address:        Packet Street 6 ◀──────────── &"address" ───  &"Packet Street 6"
-address:        128 Series of Tubes ◀──────── &"address" ───  &"128 Series of Tubes"
-address:        Internet ◀─────────────────── &"address" ───  &"Internet"
-email:          [email protected] ◀───────── &"email"   ───  &"[email protected]"
-nic-hdl:        RPSL1-RIPE ◀───────────────── &"nic-hdl" ───  &"RPSL1-RIPE"
-source:         RIPE ◀─────────────────────── &"source"  ───  &"RIPE"
+role:           ACME Company ◀─────────────── &"role":      &"ACME Company"
+address:        Packet Street 6 ◀──────────── &"address":   &"Packet Street 6"
+address:        128 Series of Tubes ◀──────── &"address":   &"128 Series of Tubes"
+address:        Internet ◀─────────────────── &"address":   &"Internet"
+email:          [email protected] ◀───────── &"email":     &"[email protected]"
+nic-hdl:        RPSL1-RIPE ◀───────────────── &"nic-hdl":   &"RPSL1-RIPE"
+source:         RIPE ◀─────────────────────── &"source":    &"RIPE"
 ```
 
 This is what makes `rpsl-rs` performant and memory efficient, since no additional allocation is required during parsing.

diff --git a/src/object.rs b/src/object.rs
@@ -14,13 +14,13 @@ use super::Attribute;
 /// ┌───────────────────────────────────────────────┐
 /// │  Object                                       │
 /// ├───────────────────────────────────────────────┤
-/// │  [role]    ───  ACME Company                  │
+/// │  [role]    ──── ACME Company                  │
 /// │  [address] ──┬─ Packet Street 6               │
 /// │              ├─ 128 Series of Tubes           │
 /// │              └─ Internet                      │
-/// │  [email]   ───  [email protected]            │
-/// │  [nic-hdl] ───  RPSL1-RIPE                    │
-/// │  [source]  ───  RIPE                          │
+/// │  [email]   ──── [email protected]            │
+/// │  [nic-hdl] ──── RPSL1-RIPE                    │
+/// │  [source]  ──── RIPE                          │
 /// └───────────────────────────────────────────────┘
 /// ```
 ///

diff --git a/src/parser/api.rs b/src/parser/api.rs
@@ -18,13 +18,13 @@ use crate::{Object, ParseError};
 /// nic-hdl:        RPSL1-RIPE
 /// source:         RIPE
 ///                        ↓
-/// role:           ACME Company ◀─────────────── &"role"    ───  &"ACME Company"
-/// address:        Packet Street 6 ◀──────────── &"address" ───  &"Packet Street 6"
-/// address:        128 Series of Tubes ◀──────── &"address" ───  &"128 Series of Tubes"
-/// address:        Internet ◀─────────────────── &"address" ───  &"Internet"
-/// email:          [email protected] ◀───────── &"email"   ───  &"[email protected]"
-/// nic-hdl:        RPSL1-RIPE ◀───────────────── &"nic-hdl" ───  &"RPSL1-RIPE"
-/// source:         RIPE ◀─────────────────────── &"source"  ───  &"RIPE"
+/// role:           ACME Company ◀─────────────── &"role":      &"ACME Company"
+/// address:        Packet Street 6 ◀──────────── &"address":   &"Packet Street 6"
+/// address:        128 Series of Tubes ◀──────── &"address":   &"128 Series of Tubes"
+/// address:        Internet ◀─────────────────── &"address":   &"Internet"
+/// email:          [email protected] ◀───────── &"email":     &"[email protected]"
+/// nic-hdl:        RPSL1-RIPE ◀───────────────── &"nic-hdl":   &"RPSL1-RIPE"
+/// source:         RIPE ◀─────────────────────── &"source":    &"RIPE"
 /// ```
 ///
 /// # Errors