Updated docs

HexMerlin · Jan 10, 2025 · bc0cd3a · bc0cd3a
1 parent 039cdbe
commit bc0cd3a
Showing 1 changed file with 27 additions and 27 deletions.
diff --git a/docs-src/ALANG.md b/docs-src/ALANG.md
@@ -9,48 +9,48 @@ The parser validates syntactic correctness and generates detailed error messages
 
 ## Alang Grammar Specification
 
-| Rule                 | Expansion                                                         |
-|----------------------|-------------------------------------------------------------------|
-| AlangExpr                 | Union                                                         |
-| :small_blue_diamond:Union            | Difference  ('\|' Difference)*         |
-| :small_blue_diamond:Difference           | Intersection ('-' Intersection)*      |
-| :small_blue_diamond:Intersectionr     | Concatenation ('&' Concatenation)*    |
-| :small_blue_diamond:Concatenation    | UnaryExpr+                      |
-| UnaryExpr           | PrimaryExpr<br>┃ Option <br>┃ KleeneStar <br>┃ KleenePlus <br>┃ Complement  |
-| :small_blue_diamond:Option           | PrimaryExpr '?'                               |
-| :small_blue_diamond:KleenStar        | PrimaryExpr '*'                               |
-| :small_blue_diamond:KleenPlus       | PrimaryExpr '+'                               |
-| :small_blue_diamond:Complement       | Primary '~'                               |
-| PrimaryExpr          | '(' AlangExpr ')' <br>┃ Atom <br>┃  Wildcard <br>┃ EmptySet    |
-| :small_blue_diamond:Atom                 | AtomChar+                                     |
-| :small_blue_diamond:Wildcard             | '.'                                           |
-| :small_blue_diamond:EmptySet          | '(' ')'                                       |
-| AtomChar             | *any character except operator characters and whitespace*  |
+| Rule                             | Expansion                                                     |
+|----------------------------------|---------------------------------------------------------------|
+| AlangExpr (root)                     | Union                                                     |
+| :small_blue_diamond:Union            | Difference  ('\|' Difference)*                            |
+| :small_blue_diamond:Difference       | Intersection ('-' Intersection)*                          |
+| :small_blue_diamond:Intersectionr    | Concatenation ('&' Concatenation)*                        |
+| :small_blue_diamond:Concatenation    | UnaryExpr+                                                |
+| UnaryExpr           | PrimaryExpr<br>┃ Option <br>┃ KleeneStar <br>┃ KleenePlus <br>┃ Complement |
+| :small_blue_diamond:Option           | PrimaryExpr '?'                                           |
+| :small_blue_diamond:KleenStar        | PrimaryExpr '*'                                           |
+| :small_blue_diamond:KleenPlus        | PrimaryExpr '+'                                           |
+| :small_blue_diamond:Complement       | Primary '~'                                               |
+| PrimaryExpr          | '(' AlangExpr ')' <br>┃ Atom <br>┃  Wildcard <br>┃ EmptySet               |
+| :small_blue_diamond:Atom                 | AtomChar+                                             |
+| :small_blue_diamond:Wildcard             | '.'                                                   |
+| :small_blue_diamond:EmptySet          | '(' ')'                                                  |
+| AtomChar             | *any character except operator characters and whitespace*                 |
 
 :small_blue_diamond: Denotes a node-type that can be included in the resulting parse tree.
 
 ## Operators Ordered by Precedence (Lowest-to-Highest)
 
 | Precedence | Operation       | Operator Character | Position & Arity   |
 |------------|-----------------|--------------------|--------------------|
-| 1          | Union           | x \| x             | Infix binary       |
-| 2          | Difference      | x - x              | Infix binary       |
-| 3          | Intersection    | x & x              | Infix binary       |
+| 1          | Union           | x \| x             | Infix Binary       |
+| 2          | Difference      | x - x              | Infix Binary       |
+| 3          | Intersection    | x & x              | Infix Binary       |
 | 4          | Concatenation   | x x                | Infix Implicit     |
-| 5          | Option          | x?                 | Postfix unary      |
-| 5          | Kleene Star     | x*                 | Postfix unary      |
-| 5          | Kleene Plus     | x+                 | Postfix unary      |
-| 5          | Complement      | x~                 | Postfix unary      |
-| 6          | Group           | ( x )              | Enclosing unary    |
+| 5          | Option          | x?                 | Postfix Unary      |
+| 5          | Kleene Star     | x*                 | Postfix Unary      |
+| 5          | Kleene Plus     | x+                 | Postfix Unary      |
+| 5          | Complement      | x~                 | Postfix Unary      |
+| 6          | Group           | ( x )              | Enclosing Unary    |
 | 7          | Empty set       | ()                 | Empty parentheses  |
 | 7          | Wildcard        | .                  | Atomic leaf        |
 | 7          | Atom            | string literal     | Atomic leaf        |
 
 ## Notes
 
 - Operators with higher precedence levels bind more tightly than those with lower levels.
-- Operators of the same precedence level are left-associative.
-- '\ws' denote any whitespace character (i.e. space, tab, newline, etc.)
+- Operators of the same precedence level are left-associative (left-to-right).
+- *Whitespace* denotes any whitespace character (i.e. space, tab, newline, etc.)
 - Atoms are user defined (alphabet symbols) and can contain any characters except for the operator characters and whitespace.
 - Wildcard '.' matches exactly one “Atom” in the alphabet.
 - Whitespace is allowed anywhere in the grammar, but it is never required unless to separate directly adjacent atoms.