docs: Add rule for tcl commands arguments order.

The-OpenROAD-Project · Oct 17, 2024 · 3e5b031 · 3e5b031
1 parent 2f10d93
commit 3e5b031
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/docs/contrib/ReadmeFormat.md b/docs/contrib/ReadmeFormat.md
@@ -29,7 +29,7 @@ for the same command.
 necessary square brackets. Also, keys have to be followed with a specifier
 whereas flags only require the `-flag` itself.
 
-As far as possible, do place the positional arguments last.
+Place the positional arguments last.
 
 ```tcl
 command_abc
@@ -39,6 +39,12 @@ command_abc
     arg1
 ```
 
+Arguments must follow this order and be sorted alphabetically within each category:
+
+1. Mandatory flags
+2. Optional flags
+3. Positional
+
 #### Options
 
 | Switch Name | Description |
@@ -96,4 +102,4 @@ about this tool.
 
 ## License
 
-BSD 3-Clause License. See [LICENSE](../../LICENSE) file.
+BSD 3-Clause License. See [LICENSE](../../LICENSE) file.