adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Update usr_51.txt to be more inclusive (#13496)

Browse Source 
use their instead of his as the user may not be male


Co-authored-by: K.Takata <kentkt@csc.jp>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
ccn
2023-11-11 03:35:50 -05:00
committed by GitHub
parent 521fb7e143
commit 2c5240ec8b
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
runtime/doc/usr_51.txt
View File

@ -103,8 +103,8 @@ NOT LOADING
It is possible that a user doesn't always want to load this plugin. Or the It is possible that a user doesn't always want to load this plugin. Or the
system administrator has dropped it in the system-wide plugin directory, but a system administrator has dropped it in the system-wide plugin directory, but a
user has his own plugin he wants to use. Then the user must have a chance to user has their own plugin they want to use. Then the user must have a chance
disable loading this specific plugin. These lines will make it possible: > to disable loading this specific plugin. These lines will make it possible: >
7 if exists("g:loaded_typecorrect") 7 if exists("g:loaded_typecorrect")
8 finish 8 finish
@ -136,7 +136,7 @@ item can be used: >
The "<Plug>TypecorrAdd;" thing will do the work, more about that further on. The "<Plug>TypecorrAdd;" thing will do the work, more about that further on.
The user can set the "g:mapleader" variable to the key sequence that he wants The user can set the "g:mapleader" variable to the key sequence that they want
plugin mappings to start with. Thus if the user has done: > plugin mappings to start with. Thus if the user has done: >
g:mapleader = "_" g:mapleader = "_"
@ -147,8 +147,8 @@ will be used, which is a backslash. Then a map for "\a" will be defined.
Note that <unique> is used, this will cause an error message if the mapping Note that <unique> is used, this will cause an error message if the mapping
already happened to exist. |:map-<unique>| already happened to exist. |:map-<unique>|
But what if the user wants to define his own key sequence? We can allow that But what if the user wants to define their own key sequence? We can allow
with this mechanism: > that with this mechanism: >
19 if !hasmapto('<Plug>TypecorrAdd;') 19 if !hasmapto('<Plug>TypecorrAdd;')
20 map <unique> <Leader>a <Plug>TypecorrAdd; 20 map <unique> <Leader>a <Plug>TypecorrAdd;
@ -156,7 +156,7 @@ with this mechanism: >
This checks if a mapping to "<Plug>TypecorrAdd;" already exists, and only This checks if a mapping to "<Plug>TypecorrAdd;" already exists, and only
defines the mapping from "<Leader>a" if it doesn't. The user then has a defines the mapping from "<Leader>a" if it doesn't. The user then has a
chance of putting this in his vimrc file: > chance of putting this in their vimrc file: >
map ,c <Plug>TypecorrAdd; map ,c <Plug>TypecorrAdd;
@ -262,7 +262,7 @@ Now let's add a user command to add a correction: >
The user command is defined only if no command with the same name already The user command is defined only if no command with the same name already
exists. Otherwise we would get an error here. Overriding the existing user exists. Otherwise we would get an error here. Overriding the existing user
command with ":command!" is not a good idea, this would probably make the user command with ":command!" is not a good idea, this would probably make the user
wonder why the command he defined himself doesn't work. |:command| wonder why the command they defined themselves doesn't work. |:command|
If it did happen you can find out who to blame with: > If it did happen you can find out who to blame with: >
verbose command Correct verbose command Correct
@ -494,7 +494,7 @@ An example of how to define functionality in a filetype plugin: >
|hasmapto()| is used to check if the user has already defined a map to |hasmapto()| is used to check if the user has already defined a map to
<Plug>JavaImport;. If not, then the filetype plugin defines the default <Plug>JavaImport;. If not, then the filetype plugin defines the default
mapping. This starts with |<LocalLeader>|, which allows the user to select mapping. This starts with |<LocalLeader>|, which allows the user to select
the key(s) he wants filetype plugin mappings to start with. The default is a the key(s) they want filetype plugin mappings to start with. The default is a
backslash. backslash.
"<unique>" is used to give an error message if the mapping already exists or "<unique>" is used to give an error message if the mapping already exists or
overlaps with an existing mapping. overlaps with an existing mapping.