Improve workspace-to-monitor-force-assignment docs

#19 (comment)
nikitabobko · Nov 20, 2023 · a193cd8 · a193cd8
1 parent 4fcc5c1
commit a193cd8
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 12 deletions.
diff --git a/config-examples/default-config.toml b/config-examples/default-config.toml
@@ -43,12 +43,12 @@ default-root-container-orientation = 'auto'
 
 # See: https://github.com/nikitabobko/AeroSpace/blob/main/docs/guide.md#assign-workspaces-to-monitors
 # [workspace-to-monitor-force-assignment]
-# workspace_name_1 = 1                            # Sequence number of the monitor from left to right. 1-based indexing
-# workspace_name_2 = 'main'                       # Main monitor
-# workspace_name_3 = 'secondary'                  # Non-main monitor in case when there are only two monitors
-# workspace_name_4 = 'built-in'                   # Case insensitive regex substring
-# workspace_name_5 = '^built-in retina display$'  # Case insensitive regex match
-# workspace_name_6 = ['secondary', 'dell']        # You can specify multiple patterns. The first matching pattern will be used
+# 1 = 1                            # Sequence number of the monitor from left to right. 1-based indexing
+# 2 = 'main'                       # Main monitor
+# 3 = 'secondary'                  # Non-main monitor in case when there are only two monitors
+# 4 = 'built-in'                   # Case insensitive regex substring
+# 5 = '^built-in retina display$'  # Case insensitive regex match
+# 6 = ['secondary', 'dell']        # You can specify multiple patterns. The first matching pattern will be used
 
 # See: https://github.com/nikitabobko/AeroSpace/blob/main/docs/guide.md#on-window-detected-callback
 # [[on-window-detected]]

diff --git a/docs/guide.md b/docs/guide.md
@@ -315,14 +315,17 @@ You can use `workspace-to-monitor-force-assignment` syntax to assign workspaces
 
 ```toml
 [workspace-to-monitor-force-assignment]
-workspace_name_1 = 1                            # Sequence number of the monitor from left to right. 1-based indexing
-workspace_name_2 = 'main'                       # Main monitor
-workspace_name_3 = 'secondary'                  # Non-main monitor in case when there are only two monitors
-workspace_name_4 = 'built-in'                   # Case insensitive regex substring
-workspace_name_5 = '^built-in retina display$'  # Case insensitive regex match
-workspace_name_6 = ['secondary', 'dell']        # You can specify multiple patterns. The first matching pattern will be used
+1 = 1                            # Sequence number of the monitor from left to right. 1-based indexing
+2 = 'main'                       # Main monitor
+3 = 'secondary'                  # Non-main monitor in case when there are only two monitors
+4 = 'built-in'                   # Case insensitive regex substring
+5 = '^built-in retina display$'  # Case insensitive regex match
+6 = ['secondary', 'dell']        # You can specify multiple patterns. The first matching pattern will be used
 ```
 
+- Left hand side of the assignment is the workspace name
+- Right hand side of the assignment is the monitor pattern
+
 Supported monitor patterns:
 - `'main'` - "Main" monitor (you can see find your "main" monitor in `System Settings -> Displays -> Use as`)
 - `'secondary'` - Non-main monitor in case when there are only two monitors