m-vim_plugins/vim-easy-align
1
0
Fork 0
mirror of https://github.com/junegunn/vim-easy-align.git synced 2025-11-11 03:13:48 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update doc

Browse Source 
- Field number -> Field index
This commit is contained in:
Junegunn Choi
2013-09-21 13:08:55 +09:00
parent 2797baca6c
commit c61a11d150
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -84,7 +84,7 @@ With the mapping, you can align selected lines of text with only a few keystroke
1. `<Enter>` key to start interactive EasyAlign command 1. `<Enter>` key to start interactive EasyAlign command
1. Optional Enter keys to select alignment mode (left, right, or center) 1. Optional Enter keys to select alignment mode (left, right, or center)
1. Optional field number (default: 1) 1. Optional field index (default: 1)
- `1` Around the 1st occurrences of delimiters - `1` Around the 1st occurrences of delimiters
- `2` Around the 2nd occurrences of delimiters - `2` Around the 2nd occurrences of delimiters
- ... - ...
@@ -247,7 +247,7 @@ my_hash = { :a => 1,
``` ```
However, in this case, we don't really need blockwise visual mode However, in this case, we don't really need blockwise visual mode
since the same can be easily done using the negative field number: `<Enter>-=` since the same can be easily done using the negative field index: `<Enter>-=`
Alignment options Alignment options
----------------- -----------------
@@ -508,7 +508,7 @@ let g:easy_align_bang_interactive_modes = ['c', 'r']
### Alignments over multiple occurrences of delimiters ### Alignments over multiple occurrences of delimiters
As stated above, "field number" is used to target specific occurrences of As stated above, "field index" is used to target specific occurrences of
the delimiter when it appears multiple times in each line. the delimiter when it appears multiple times in each line.
To recap: To recap:

6
doc/easy_align.txt
View File

@@ -36,7 +36,7 @@ With this mapping, you can align selected lines of text with a few keystrokes.
1. <Enter> key to start interactive EasyAlign command 1. <Enter> key to start interactive EasyAlign command
2. Optional Enter keys to select alignment mode (left, right, or center) 2. Optional Enter keys to select alignment mode (left, right, or center)
3. Optional field number (default: 1) 3. Optional field index (default: 1)
1 Around the 1st occurrences of delimiters 1 Around the 1st occurrences of delimiters
2 Around the 2nd occurrences of delimiters 2 Around the 2nd occurrences of delimiters
* Around all occurrences of delimiters * Around all occurrences of delimiters
@@ -175,7 +175,7 @@ Available options are as follows.
| | | (right, left, center) | | | | (right, left, center) |
| indentation | string | 'k' | | indentation | string | 'k' |
| | | (keep, shallow, deep, none) | | | | (keep, shallow, deep, none) |
| mode_sequence | string | (Depends on field number and | | mode_sequence | string | (Depends on field index and |
| | | selected alignment mode) | | | | selected alignment mode) |
There are 4 ways to set alignment options (from lowest precedence to highest): There are 4 ways to set alignment options (from lowest precedence to highest):
@@ -407,7 +407,7 @@ settings as follows.
Alignments over multiple occurrences of delimiters Alignments over multiple occurrences of delimiters
------------------------------------------------------------------------- -------------------------------------------------------------------------
As stated above, "field number" is used to target specific occurrences of As stated above, "field index" is used to target specific occurrences of
the delimiter when it appears multiple times in each line. the delimiter when it appears multiple times in each line.
To recap: To recap: