Skip to content

Commit d619dcc

Browse files
committed
Clarify swapping in readme
1 parent f1c0f6b commit d619dcc

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,17 @@ and then feel lost, you always have `Ctrl-o` available to bring you back to wher
4141

4242
## Swapping
4343

44-
The swap commands swap nodes, with up/down **bringing along attached comments, annotations, and decorators**:
44+
`Swap{Up,Down}` operate on a linewise basis, and **bring along their comments, decorators, and annotations**.
45+
These are meant for swapping declarations and definitions - things that take up whole lines.
4546

46-
* **`:Treewalker SwapUp`** - Swaps nodes upwards in your code with the previous line wise node
47-
* **`:Treewalker SwapDown`** - Swaps nodes downward in your code with the next line wise node
48-
49-
`Swap{Up,Down}` are meant for swapping declarations and definitions. Things that take up a whole line.
47+
`Swap{Left,Right}` are meant for swapping function arguments, enum members, list elements, etc. Things that are many per line.
48+
In some cases these will operate on the same nodes as Up/Down, but won't take the accoutrements.
5049

50+
* **`:Treewalker SwapUp`** - Swaps the highest node on the line upwards in the document
51+
* **`:Treewalker SwapDown`** - Swaps the biggest node on the line downward in the document
5152
* **`:Treewalker SwapLeft`** - Swap the node under the cursor with its previous neighbor
5253
* **`:Treewalker SwapRight`** - Swap the node under the cursor with its next neighbor
5354

54-
`Swap{Left,Right}` are meant for swapping function arguments, enum members, list elements, etc. Things that are many per line.
55-
5655
---
5756

5857
## More Examples

0 commit comments

Comments
 (0)