documentation formatting: Wed Dec 5 03:03:03 UTC 2018

syl20bnr · Dec 5, 2018 · 45276bd · 45276bd
1 parent cc1764b
commit 45276bd
Show file tree

Hide file tree

Showing 152 changed files with 711 additions and 702 deletions.
diff --git a/doc/CONVENTIONS.org b/doc/CONVENTIONS.org
@@ -208,7 +208,7 @@ History navigation in shells or REPLs buffers should be bound as well to
 ** Building and Compilation
 The base prefix for major mode specific compilation is ~SPC m c~.
 
-| Key Binding | Description       |
+| Key binding | Description       |
 |-------------+-------------------|
 | ~m c b~     | compile buffer    |
 | ~m c c~     | compile           |
@@ -221,7 +221,7 @@ implement an auto-save of the buffer before compiling the buffer.
 ** Debugging
 The base prefix for debugging commands is ~SPC m d~.
 
-| Key Binding | Description             |
+| Key binding | Description             |
 |-------------+-------------------------|
 | ~m d a~     | abandon current process |
 | ~m d b~     | toggle a breakpoint     |
@@ -244,7 +244,7 @@ Notes:
 ** Errors
 Management of errors should be put under ~SPC m E~.
 
-| Key Binding | Description                         |
+| Key binding | Description                         |
 |-------------+-------------------------------------|
 | ~m E e~     | fix error around point              |
 | ~m E l~     | show errors                         |
@@ -257,7 +257,7 @@ keybindings whenever applicable.
 *** Headers
 All header functionality should be grouped under ~SPC m h~
 
-| Key Binding | Description                                      |
+| Key binding | Description                                      |
 |-------------+--------------------------------------------------|
 | ~m h i~     | Insert a header                                  |
 | ~m h I~     | Insert a header alternative method (if existing) |
@@ -267,7 +267,7 @@ All header functionality should be grouped under ~SPC m h~
 Insertion of common elements like links or footnotes should be grouped
 under ~SPC m i~
 
-| Key Binding | Description      |
+| Key binding | Description      |
 |-------------+------------------|
 | ~m i f~     | Insert footnote  |
 | ~m i i~     | Insert image     |
@@ -278,7 +278,7 @@ under ~SPC m i~
 *** Text manipulation
 Manipulation of text regions should be grouped under ~SPC m x~
 
-| Key Binding | Description                   |
+| Key binding | Description                   |
 |-------------+-------------------------------|
 | ~m x b~     | Make region bold              |
 | ~m x c~     | Make region code              |
@@ -290,9 +290,9 @@ Manipulation of text regions should be grouped under ~SPC m x~
 | ~m x v~     | Make region verbose           |
 
 *** Movement in normal mode
-In normal mode Vim style movement should be enabled with these keybindings:
+In normal mode Vim style movement should be enabled with these key bindings:
 
-| Key Binding | Description                            |
+| Key binding | Description                            |
 |-------------+----------------------------------------|
 | ~g h~       | Move up one level in headings          |
 | ~g j~       | Move to next heading on same level     |
@@ -304,7 +304,7 @@ Promotion, demotion and movement of headings or list elements (whatever is
 possible) should be enabled with the following keys when in Vim style or
 Hybrid with hjkl movements enabled:
 
-| Key Binding | Description                  |
+| Key binding | Description                  |
 |-------------+------------------------------|
 | ~M-h~       | Promote heading by one level |
 | ~M-j~       | Move element down            |
@@ -314,7 +314,7 @@ Hybrid with hjkl movements enabled:
 In all editing styles promotion and demotion can be done with the following
 keys:
 
-| Key Binding | Description                  |
+| Key binding | Description                  |
 |-------------+------------------------------|
 | ~M-down~    | Move element down            |
 | ~M-left~    | Promote heading by one level |
@@ -369,7 +369,7 @@ Refactoring prefix is ~SPC m r~.
 ** Code Formatting
 Major-mode code formatting is under prefix ~SPC m =~.
 
-| Key Binding | Description              |
+| Key binding | Description              |
 |-------------+--------------------------|
 | ~m = =~     | format thing under point |
 | ~m = b~     | format current buffer    |

diff --git a/doc/DOCUMENTATION.org b/doc/DOCUMENTATION.org
diff --git a/doc/QUICK_START.org b/doc/QUICK_START.org
@@ -166,7 +166,7 @@ backslash, an actual space and a lowercase ~b~.
 =Describe functions= are powerful Emacs introspection commands to get information
 about functions, variables, modes etc. These commands are bound thusly:
 
-| Key Binding | Description       |
+| Key binding | Description       |
 |-------------+-------------------|
 | ~SPC h d f~ | describe-function |
 | ~SPC h d k~ | describe-key      |

diff --git a/doc/VIMUSERS.org b/doc/VIMUSERS.org
@@ -184,7 +184,7 @@ explore:
 | Key binding | Function                                                      |
 |-------------+---------------------------------------------------------------|
 | ~SPC h SPC~ | Lists all layers and allows you to view files from the layer. |
-| ~SPC ?~     | Lists all keybindings.                                        |
+| ~SPC ?~     | Lists all key bindings.                                       |
 
 * Customization
 ** The .spacemacs file
@@ -450,7 +450,7 @@ that is loaded at startup. Here is an example:
                                           gotham)))
 #+END_SRC
 
-All installed themes can be listed and chosen using the ~SPC T h~ keybinding.
+All installed themes can be listed and chosen using the ~SPC T h~ key binding.
 
 *** Nohlsearch
 Spacemacs emulates the default vim behavior which highlights search results even

diff --git a/layers/+chat/erc/README.org b/layers/+chat/erc/README.org
@@ -100,7 +100,7 @@ read that in =:password=.
 
 * Key bindings
 
-| Key Binding | Description                                           |
+| Key binding | Description                                           |
 |-------------+-------------------------------------------------------|
 | ~SPC a i e~ | Starts ERC                                            |
 | ~SPC a i E~ | Starts ERC via TLS/SSL                                |

diff --git a/layers/+chat/jabber/README.org b/layers/+chat/jabber/README.org
@@ -25,12 +25,12 @@ file.
 
 * Key bindings
 
-| Key Binding | Description          |
+| Key binding | Description          |
 | ~SPC a j~   | Connect all accounts |
 
 ** Jabber Roster
 
-| Key Binding | Description                          |
+| Key binding | Description                          |
 | ~SPC m a~   | Jabber send presence                 |
 | ~SPC m b~   | Jabber get browse                    |
 | ~SPC m d~   | Jabber disconnect                    |

diff --git a/layers/+chat/rcirc/README.org b/layers/+chat/rcirc/README.org
@@ -17,7 +17,7 @@
       - [[#disclaimer][Disclaimer]]
       - [[#note][Note]]
   - [[#enabling-sfoobar][Enabling =s/foo/bar/=]]
-- [[#key-bindings][Key Bindings]]
+- [[#key-bindings][Key bindings]]
 - [[#rcirc-documentation][Rcirc documentation]]
 - [[#spacemacs-layout-support][Spacemacs Layout Support]]
 
@@ -176,16 +176,16 @@ variable =rcirc-enable-late-fix= to =t= in your dotfile:
     (rcirc :variables rcirc-enable-late-fix t)))
 #+END_SRC
 
-* Key Bindings
+* Key bindings
 
-| Key Binding | Description                                                                   |
+| Key binding | Description                                                                   |
 |-------------+-------------------------------------------------------------------------------|
 | ~SPC a i r~ | Open rcirc                                                                    |
 | ~SPC l o i~ | Open rcirc in a custom perspective “@RICRC” (need perspectives layer enabled) |
 
 In normal state:
 
-| Key Binding | Description              |
+| Key binding | Description              |
 |-------------+--------------------------|
 | ~C-j~       | next item in history     |
 | ~C-k~       | previous item in history |

diff --git a/layers/+chat/slack/README.org b/layers/+chat/slack/README.org
@@ -62,7 +62,7 @@ By default the values are:
 
 * Key bindings
 
-| Key Binding | Description                             |
+| Key binding | Description                             |
 |-------------+-----------------------------------------|
 | ~SPC a C d~ | Direct message someone                  |
 | ~SPC a C g~ | Join a group (private channel)          |
@@ -84,7 +84,7 @@ By default the values are:
 The following bindings are provided to mimic bindings in the official Slack
 client.
 
-| Key Binding | Description              |
+| Key binding | Description              |
 |-------------+--------------------------|
 | ~SPC m @~   | Embed mention of user    |
 | ~SPC m #~   | Embed mention of channel |

diff --git a/layers/+checkers/spell-checking/README.org b/layers/+checkers/spell-checking/README.org
@@ -10,7 +10,7 @@
   - [[#enabling-auto-dictionary-mode][Enabling auto-dictionary-mode]]
   - [[#enabling-multi-dictionary-support-with-hunspell][Enabling multi-dictionary support with hunspell]]
   - [[#enable-auto-completion-popup][Enable auto-completion popup]]
-- [[#key-bindings][Key Bindings]]
+- [[#key-bindings][Key bindings]]
   - [[#spell-checking-transient-state][Spell Checking Transient-state]]
 - [[#known-issues][Known issues]]
 
@@ -118,9 +118,9 @@ set the layer variable =enable-flyspell-auto-completion= to t:
     '((spell-checking :variables enable-flyspell-auto-completion t)))
 #+END_SRC
 
-* Key Bindings
+* Key bindings
 
-| Key Binding     | Description                            |
+| Key binding     | Description                            |
 |-----------------+----------------------------------------|
 | ~SPC S b~       | flyspell whole buffer                  |
 | ~SPC S c~       | flyspell correct                       |
@@ -131,7 +131,7 @@ set the layer variable =enable-flyspell-auto-completion= to t:
 
 ** Spell Checking Transient-state
 
-| Key Binding | Description                                      |
+| Key binding | Description                                      |
 |-------------+--------------------------------------------------|
 | ~SPC S . b~ | Rerun spell check for the whole buffer           |
 | ~SPC S . d~ | Change dictionary                                |

diff --git a/layers/+checkers/syntax-checking/README.org b/layers/+checkers/syntax-checking/README.org
@@ -10,7 +10,7 @@
   - [[#enablingdisabling-tooltips][Enabling/Disabling tooltips]]
   - [[#disabling-by-default][Disabling by default]]
   - [[#bitmaps][Bitmaps]]
-- [[#key-bindings][Key Bindings]]
+- [[#key-bindings][Key bindings]]
 
 * Description
 This layer adds on the fly syntax checking to all supported language layers.
@@ -61,9 +61,9 @@ variable =syntax-checking-use-original-bitmaps= to =t=:
     '((syntax-checking :variables syntax-checking-use-original-bitmaps t)))
 #+END_SRC
 
-* Key Bindings
+* Key bindings
 
-| Key Binding | Description                                                  |
+| Key binding | Description                                                  |
 |-------------+--------------------------------------------------------------|
 | ~SPC e b~   | check for errors now                                         |
 | ~SPC e c~   | clear errors                                                 |

diff --git a/layers/+completion/auto-completion/README.org b/layers/+completion/auto-completion/README.org
@@ -15,7 +15,7 @@
   - [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]]
   - [[#completion-back-ends][Completion back ends]]
   - [[#improved-faces][Improved faces]]
-- [[#key-bindings-1][Key Bindings]]
+- [[#key-bindings-1][Key bindings]]
   - [[#company][Company]]
   - [[#auto-complete][Auto-complete]]
   - [[#yasnippet][Yasnippet]]
@@ -200,10 +200,10 @@ For nicer-looking faces, try adding the following to `custom-set-faces` in your
      ((t (:inherit company-tooltip-selection :weight bold :underline nil)))))
 #+END_SRC
 
-* Key Bindings
+* Key bindings
 ** Company
 
-| Key Binding | Description                                                                                          |
+| Key binding | Description                                                                                          |
 |-------------+------------------------------------------------------------------------------------------------------|
 | ~C-d~       | open minibuffer with documentation of thing at point in company dropdown                             |
 | ~C-/~       | show candidates in Helm or Ivy (for fuzzy searching)                                                 |
@@ -212,22 +212,22 @@ For nicer-looking faces, try adding the following to `custom-set-faces` in your
 
 Vim Style:
 
-| Key Binding | Description                                  |
+| Key binding | Description                                  |
 |-------------+----------------------------------------------|
 | ~C-j~       | (vim style) go down in company dropdown menu |
 | ~C-k~       | (vim style) go up in company dropdown menu   |
 | ~C-l~       | (vim style) complete selection               |
 
 Emacs style:
 
-| Key Binding | Description                                    |
+| Key binding | Description                                    |
 |-------------+------------------------------------------------|
 | ~C-n~       | (emacs style) go down in company dropdown menu |
 | ~C-p~       | (emacs style) go up in company dropdown menu   |
 
 ** Auto-complete
 
-| Key Binding | Description                                                          |
+| Key binding | Description                                                          |
 |-------------+----------------------------------------------------------------------|
 | ~C-j~       | select next candidate                                                |
 | ~C-k~       | select previous candidate                                            |
@@ -237,14 +237,14 @@ Emacs style:
 
 ** Yasnippet
 
-| Key Binding | Description                                                    |
+| Key binding | Description                                                    |
 |-------------+----------------------------------------------------------------|
 | ~M-/~       | Expand a snippet if text before point is a prefix of a snippet |
 | ~SPC i s~   | List all current yasnippets for inserting                      |
 
 ** Auto-yasnippet
 
-| Key Binding | Description                                                               |
+| Key binding | Description                                                               |
 |-------------+---------------------------------------------------------------------------|
 | ~SPC i S c~ | create a snippet from an active region                                    |
 | ~SPC i S e~ | Expand the snippet just created with ~SPC i y~                            |

diff --git a/layers/+completion/helm/README.org b/layers/+completion/helm/README.org
@@ -128,7 +128,7 @@ When using the Vim style or Hybrid style with the variable
 =hybrid-style-enable-hjkl-bindings= set to =t=, Spacemacs adds navigation in the
 Helm buffers with ~hjkl~.
 
-| Key Binding | Description                  |
+| Key binding | Description                  |
 |-------------+------------------------------|
 | ~C-h~       | go to next source            |
 | ~C-H~       | describe key (replace ~C-h~) |
@@ -142,7 +142,7 @@ plugin.
 
 Initiate the transient state with ~M-SPC~ or ~s-M-SPC~ while in a =Helm= buffer.
 
-| Key Binding          | Description                                          |
+| Key binding          | Description                                          |
 |----------------------+------------------------------------------------------|
 | ~M-SPC~ or ~s-M-SPC~ | initiate the transient state                         |
 | ~q~                  | quit transient state                                 |
@@ -171,7 +171,7 @@ Initiate the transient state with ~M-SPC~ or ~s-M-SPC~ while in a =Helm= buffer.
 ** Bookmarks
 In the =helm-bookmarks= buffer:
 
-| Key Binding | Description                                  |
+| Key binding | Description                                  |
 |-------------+----------------------------------------------|
 | ~C-d~       | delete the selected bookmark                 |
 | ~C-e~       | edit the selected bookmark                   |
@@ -194,7 +194,7 @@ real-time and navigate between them easily.
 You can even edit the occurrences directly in the =helm= buffer and apply the
 modifications to the buffer.
 
-| Key Binding | Description                    |
+| Key binding | Description                    |
 |-------------+--------------------------------|
 | ~SPC s s~   | execute =helm-swoop=           |
 | ~SPC s S~   | execute =helm-multi-swoop=     |

diff --git a/layers/+completion/ivy/README.org b/layers/+completion/ivy/README.org
@@ -7,7 +7,7 @@
 - [[#configuration][Configuration]]
   - [[#general][General]]
   - [[#advanced-buffer-information][Advanced buffer information]]
-- [[#key-bindings][Key Bindings]]
+- [[#key-bindings][Key bindings]]
   - [[#transient-state][Transient state]]
 
 * Description
@@ -64,14 +64,14 @@ is disabled by default.
     (ivy :variables ivy-enable-advanced-buffer-information t)))
 #+END_SRC
 
-* Key Bindings
+* Key bindings
 If you choose =ivy= as completion system, make sure to read the [[http://oremacs.com/swiper/][official manual]].
 In case you don’t want to read everything, at least familiarise with
 [[http://oremacs.com/swiper/#minibuffer-key-bindings][minibuffer key bindings]].
 
 Some useful key bindings are presented in the following table.
 
-| Key Binding | Description                                                                                          |
+| Key binding | Description                                                                                          |
 |-------------+------------------------------------------------------------------------------------------------------|
 | ~RET~       | call default action on current candidate                                                             |
 | ~M-RET~     | the same as ~RET~ but doesn’t close completion minibuffer                                            |
@@ -85,7 +85,7 @@ Some useful key bindings are presented in the following table.
 ** Transient state
 Press ~M-SPC~ anytime in Ivy to get into the transient state.
 
-| Key Binding | Description                                             |
+| Key binding | Description                                             |
 |-------------+---------------------------------------------------------|
 | ~j~         | select next candidate                                   |
 | ~k~         | select previous candidate                               |

diff --git a/layers/+emacs/better-defaults/README.org b/layers/+emacs/better-defaults/README.org
@@ -49,7 +49,7 @@ Choose if ~C-e~ first brings you to the end of the line or the end of the code
 
 * Key bindings
 
-| Key Binding | Description                                                                      |
+| Key binding | Description                                                                      |
 |-------------+----------------------------------------------------------------------------------|
 | ~C-a~       | move to beginning of line or code                                                |
 | ~C-e~       | move to end of line or code                                                      |