diff options
| author | Frank LENORMAND <lenormf@gmail.com> | 2017-04-21 13:32:47 +0300 |
|---|---|---|
| committer | Frank LENORMAND <lenormf@gmail.com> | 2017-04-21 13:59:38 +0300 |
| commit | 41822f630c859b994fa463dcea2e64dd24dcc8a6 (patch) | |
| tree | 6e51f573b59ae3f87428ec15c317c903b0a02d85 /doc | |
| parent | e722868c6014afd6815710766c9e2c9a402f6afb (diff) | |
doc: Fix some issues in spelling, grammar and punctuation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/autoedit.asciidoc | 2 | ||||
| -rw-r--r-- | doc/design.asciidoc | 14 | ||||
| -rw-r--r-- | doc/interfacing.asciidoc | 10 | ||||
| -rw-r--r-- | doc/kak.1.txt | 2 | ||||
| -rw-r--r-- | doc/manpages/commands.asciidoc | 10 | ||||
| -rw-r--r-- | doc/manpages/execeval.asciidoc | 2 | ||||
| -rw-r--r-- | doc/manpages/faq.asciidoc | 4 | ||||
| -rw-r--r-- | doc/manpages/highlighters.asciidoc | 8 | ||||
| -rw-r--r-- | doc/manpages/hooks.asciidoc | 10 | ||||
| -rw-r--r-- | doc/manpages/keys.asciidoc | 10 | ||||
| -rw-r--r-- | doc/manpages/options.asciidoc | 8 | ||||
| -rw-r--r-- | doc/manpages/registers.asciidoc | 2 |
12 files changed, 41 insertions, 41 deletions
diff --git a/doc/autoedit.asciidoc b/doc/autoedit.asciidoc index 2b967e97..f82ecd78 100644 --- a/doc/autoedit.asciidoc +++ b/doc/autoedit.asciidoc @@ -41,7 +41,7 @@ allowing for clearer separation. either use <space> or quote the argument to use a space key) That works, however if the phase *2.* raises an error, the +:exec+ will stop -and the user will get it's selections on the previous line. the solution +and the user will get its selections on the previous line. The solution is to use a *draft* context, instead of the one the user is interacting with. --------------------------------------------------------------- diff --git a/doc/design.asciidoc b/doc/design.asciidoc index eb022e8e..4df1a95d 100644 --- a/doc/design.asciidoc +++ b/doc/design.asciidoc @@ -22,8 +22,8 @@ and should, as a side effect, be very efficient at editing text in general. Composability ------------- -Being limited in scope to code edition should not isolate Kakoune from it's -environment. On the contrary, Kakoune is expected to run on an Unix-like +Being limited in scope to code edition should not isolate Kakoune from its +environment. On the contrary, Kakoune is expected to run on a Unix-like system, along with a lot of text-based tools, and should make it easy to interact with these tools. @@ -35,14 +35,14 @@ The modern Unix environment is not limited to text filters, most people use a graphical interface nowadays, and Kakoune should be able to take advantage of that, without hindering text mode support. For example Kakoune supports multiple clients on the same editing session, so that multiple windows can -be used, letting the system window manager handle it's responsibilities such +be used, letting the system window manager handle its responsibilities such as tiling or tabbing. Orthogonality ------------- Kakoune features should be as orthogonal as possible, for example, in Vim, -there is multiple ways for modifying the buffer: Through normal/insert +there are multiple ways for modifying the buffer: Through normal/insert mode, command mode, and Vim scripts. In Kakoune, modifying the buffer is the normal/insert mode job. @@ -74,7 +74,7 @@ keystrokes, and fast to execute. or the same number of keys. * Kakoune be designed with asynchronicity in mind, launching a background - process and using it's result when available should not block the editor. + process and using its result when available should not block the editor. * Kakoune should be implemented with speed in mind, a slow editor is a useless one. @@ -131,6 +131,6 @@ possible be integrated with the code so that it stays up to date. Vim compatibility ----------------- -Kakoune is inspired by Vim, and should try to keep it's commands close to Vim -ones if there is no compelling reasons to change. However self consistency +Kakoune is inspired by Vim, and should try to keep its commands close to +Vim's if there are no compelling reasons to change. However self-consistency is more important than Vim compatibility. diff --git a/doc/interfacing.asciidoc b/doc/interfacing.asciidoc index f896b175..1b3f8d10 100644 --- a/doc/interfacing.asciidoc +++ b/doc/interfacing.asciidoc @@ -48,7 +48,7 @@ For example, we can echo a message in Kakoune in 10 seconds with: Interactive output ------------------ -It is a frequent interaction mode to run a program and display it's output +It is a frequent interaction mode to run a program and display its output in a Kakoune buffer. The common pattern to do that is to use a fifo buffer: @@ -81,19 +81,19 @@ Completion candidates Filetype specific completion should be provided by external programs. -external completions are provided using an option to store completion, which +External completions are provided using an option to store completion, which have the following format. ---- line.column[+len]@timestamp:candidate1|desc1|menu1:candidate2|desc2|menu2:... ---- -the first element of this string list specify where and when this completions +the first element of this string list specify where and when this completion applies, the others are a triplet `<completion text>|<docstring>|<menu text>` -The menu text is a a markup string, so it can contain `{face}` directives. +The menu text is a markup string, so it can contain `{face}` directives. -to effectively use that completion option, it should get added to the completers +To effectively use that completion option, it should get added to the completers option. --- diff --git a/doc/kak.1.txt b/doc/kak.1.txt index e010048c..4d20911a 100644 --- a/doc/kak.1.txt +++ b/doc/kak.1.txt @@ -100,7 +100,7 @@ which will source additional files: * if the *$XDG_CONFIG_HOME*'/kak/autoload' directory exists, load every '*.kak' files in it, and load recursively any subdirectory - * if it does not exists, fall back to the system wide autoload directory in '../share/kak/autoload' + * if it does not exist, fall back to the system wide autoload directory in '../share/kak/autoload' After that, if it exists, source the *$XDG_CONFIG_HOME*'/kak/kakrc' file which should be used for user configuration. In order to continue autoloading site-wide files with a local autoload directory, just add a symbolic diff --git a/doc/manpages/commands.asciidoc b/doc/manpages/commands.asciidoc index cb20a832..a849baec 100644 --- a/doc/manpages/commands.asciidoc +++ b/doc/manpages/commands.asciidoc @@ -25,7 +25,7 @@ command *q!* has to be used). opened, just switch to this file. Use edit! to force reloading *w[rite][!]* [<filename>]:: - write buffer to <filename> or use it's name if filename is not + write buffer to <filename> or use its name if filename is not given. If the file is write-protected, its permissions are temporarily changed to allow saving the buffer and restored afterwards when the write! command is used. @@ -168,7 +168,7 @@ commands: *menu* <label1> <commands1> <label2> <commands2> ...:: display a menu using labels, the selected label’s commands are - executed. menu can take an *-auto-single* argument, to automatically + executed. The *menu* command can take an *-auto-single* argument, to automatically run commands when only one choice is provided, and a *-select-cmds* argument, in which case menu takes three argument per item, the last one being a command to execute when the item is selected (but @@ -187,7 +187,7 @@ commands: set the title of the message box *try* <commands> catch <on_error_commands>:: - prevent an error in *commands* from aborting the whole commands + prevent an error in *commands* from aborting the whole command execution, execute *on_error_commands* instead. If nothing is to be done on error, the catch part can be omitted @@ -243,8 +243,8 @@ New commands can be defined using the *define-command* command: *-docstring*::: define the documentation string for the command -Using shell expansion allows to define complex commands or to access Kakoune -state: +Using shell expansion allows defining complex commands or accessing +Kakoune's state: -------------------------------------------------------- def " print_selection %{ echo %sh{ ${kak_selection} } }" diff --git a/doc/manpages/execeval.asciidoc b/doc/manpages/execeval.asciidoc index 224fd99b..0d919534 100644 --- a/doc/manpages/execeval.asciidoc +++ b/doc/manpages/execeval.asciidoc @@ -40,7 +40,7 @@ Optional flags *-itersel* (requires -draft):: execute once per selection, in a context with only the considered - selection. This permits to avoid cases where the selections may + selection. This permits avoiding cases where the selections may get merged *-buffer* <names>:: diff --git a/doc/manpages/faq.asciidoc b/doc/manpages/faq.asciidoc index 6bb4d246..ca40041c 100644 --- a/doc/manpages/faq.asciidoc +++ b/doc/manpages/faq.asciidoc @@ -10,7 +10,7 @@ How to pronounce the name of the project and what does it mean ? The name of the project is pronounced "Kak-oon", and is a word taken from a New Caledonian dialect based on french. It means a hard blow, usually a punch, -but generally refers to a blow into which which all of one's strength went. +but generally refers to a blow into which all of one's strength went. Is there going to be a Windows port of Kakoune ? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -127,7 +127,7 @@ Why aren't there other scopes similar to `%sh{}` e.g. python ? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Supporting custom scopes would add hard dependencies to the project, which -is too much of an drawback when balanced against the low cost of using +is too much of a drawback when balanced against the low cost of using an interpreter in a regular shell scope (e.g. `%sh{ python -c "..." }`). The shell scope allows users to spawn any interpreter they want, for a minimal cost in terms of performance, it is therefore the reason why it's the only diff --git a/doc/manpages/highlighters.asciidoc b/doc/manpages/highlighters.asciidoc index 17634db0..b196c268 100644 --- a/doc/manpages/highlighters.asciidoc +++ b/doc/manpages/highlighters.asciidoc @@ -48,7 +48,7 @@ General highlighters every line contained in the int-list option named <option_name> *show_matching*:: - highlight matching char of the character under the selections cursor + highlight matching char of the character under the selections' cursor using MatchingChar face *show_whitespaces* [options]:: @@ -62,7 +62,7 @@ General highlighters a one character long separator that will replace spaces *-nbsp* <separator>::: - a one character long separator that will replace non breakable spaces + a one character long separator that will replace non-breakable spaces *-tab* <separator>::: a one character long separator that will replace tabulations @@ -151,7 +151,7 @@ This region can be defined with: shell_expand %sh\{ \} \{ ------------------------ -Regions are used in the regions highlighter which can take any number +Regions are used in the region highlighters which can take any number of regions. The following command: @@ -180,7 +180,7 @@ If the *-match-capture* switch is passed, then region closing and recurse matches are considered valid for a given region opening match only if they matched the same content for the capture 1. -Most programming languages can then be properly highlighted using a regions +Most programming languages can then be properly highlighted using a region highlighter as root: ----------------------------------------------------------------- diff --git a/doc/manpages/hooks.asciidoc b/doc/manpages/hooks.asciidoc index d88f52b9..0207d2b4 100644 --- a/doc/manpages/hooks.asciidoc +++ b/doc/manpages/hooks.asciidoc @@ -28,7 +28,7 @@ following command: hook global WinCreate .*\.cc %{ add-highlighter number_lines } ---------------------------------------------------- -if *group* is given, make this hook part of the named group. Groups are used +If *group* is given, make this hook part of the named group. Groups are used for removing hooks with the following command: ----------------------- @@ -130,7 +130,7 @@ Default hooks or because the writing end has been closed *RuntimeError*:: - an error was encountered while executing an user command the error + an error was encountered while executing a user command the error message is used for filtering *KakBegin*:: @@ -141,11 +141,11 @@ Default hooks kakoune is quitting *FocusIn*:: - on supported clients, triggered when the client gets focused. the + on supported clients, triggered when the client gets focused. The filtering text is the client name *FocusOut*:: - on supported clients, triggered when the client gets unfocused. the + on supported clients, triggered when the client gets unfocused. The filtering text is the client name *InsertCompletionShow*:: @@ -155,7 +155,7 @@ Default hooks Triggered when the insert completion menu gets hidden *RawKey*:: - Triggered whenever an key is pressed by the user, the key is + Triggered whenever a key is pressed by the user, the key is used for filtering. When not specified, the filtering text is an empty string. Note that diff --git a/doc/manpages/keys.asciidoc b/doc/manpages/keys.asciidoc index d3913b23..1290a2b7 100644 --- a/doc/manpages/keys.asciidoc +++ b/doc/manpages/keys.asciidoc @@ -76,7 +76,7 @@ Using Counts In normal mode, commands can be prefixed with a numeric count, which can control the command behaviour. -for example, *3W* selects 3 consecutive words and *3w* select the third word on +For example, *3W* selects 3 consecutive words and *3w* select the third word on the right of selection end. Disabling Hooks @@ -227,11 +227,11 @@ Changes enter insert mode at current selection end line end *o*:: - enter insert mode in one (or given count) new lines below + enter insert mode in a new line (or in a given count of new lines) below current selection end *O*:: - enter insert mode in a on (or given count) lines above + enter insert mode in a new line (or in a given count of new lines) above current selection begin *y*:: @@ -498,7 +498,7 @@ Object Selection selects the whole object *<a-i>*:: - selects the inner object, that is the object excluding it's surrounder + selects the inner object, that is the object excluding its surrounder *[*:: selects to object start @@ -582,7 +582,7 @@ Prompt Commands move cursor to first character *<end>*:: - move cursor to passed last character + move cursor past the last character *<backspace>*, *<a-x>*:: erase character before cursor diff --git a/doc/manpages/options.asciidoc b/doc/manpages/options.asciidoc index a8052cf7..d5954a17 100644 --- a/doc/manpages/options.asciidoc +++ b/doc/manpages/options.asciidoc @@ -23,7 +23,7 @@ Types to contain a colon, it can be escaped with a backslash *range-faces*:: - a `:` separated list of a pairs of a buffer range + a `:` separated list of a pair of a buffer range (`<begin line>.<begin column>,<end line>.<end column>` or `<begin line>.<begin column>+<length>`) and a face (separated by `|`), except for the first element which is just the timestamp of the buffer. @@ -60,7 +60,7 @@ Builtin options ignored *BOM* 'enum(none|utf8)':: - define if the file should be written with an unicode byte order mark; + define if the file should be written with a unicode byte order mark; values of this option assigned to the `window` scope are ignored *readonly* 'bool':: @@ -82,12 +82,12 @@ Builtin options automatically display possible completions when editing a prompt *ignored_files* 'regex':: - filenames matching this regex wont be considered as candidates on + filenames matching this regex won't be considered as candidates on filename completion (except if the text being completed already matches it) *disabled_hooks* 'regex':: - hooks whose group matches this regex wont be executed. For example + hooks whose group matches this regex won't be executed. For example indentation hooks can be disabled with '.*-indent' *filetype* 'str':: diff --git a/doc/manpages/registers.asciidoc b/doc/manpages/registers.asciidoc index 163bf70e..9e3366f8 100644 --- a/doc/manpages/registers.asciidoc +++ b/doc/manpages/registers.asciidoc @@ -23,7 +23,7 @@ Interacting Alternate names --------------- -non alphanumeric registers have an alternative name that can be used +Non alphanumeric registers have an alternative name that can be used in contexts where only alphanumeric identifiers are possible. Default registers |
