Skip to content

Commit

Permalink
documentation fixes: Tue Oct 23 14:18:21 UTC 2018
Browse files Browse the repository at this point in the history
  • Loading branch information
emacspace authored and JAremko committed Oct 23, 2018
1 parent 8f30ba8 commit 901f358
Show file tree
Hide file tree
Showing 53 changed files with 271 additions and 271 deletions.
30 changes: 15 additions & 15 deletions CHANGELOG.org
Expand Up @@ -796,7 +796,7 @@
- Defer =company-web= loading (ralesi)

**** IBuffer
- New key bindings ~g r~ to update buffer, ~g j~ to move to next filter group
- New key bindings ~g r~ to update buffer, ~g j~ to move to next filter group
and ~g k~ to move to previous filter group (thanks to donm)

**** IPthon-notebook
Expand Down Expand Up @@ -895,7 +895,7 @@
*** Improvements
- Improve home buffer responsiveness, add centering for release notes and lists
(thanks to deb0ch)
- Add keybindings to move buffers by window number with ~SPC b #~ where
- Add key bindings to move buffers by window number with ~SPC b #~ where
~#~ is a number between 0 and 9 (thanks to quicknir)
- Add toggle to display time in modeline on ~SPC t m t~. Toggle of the modeline
is now in ~SPC t m T~. (thanks to jupl)
Expand Down Expand Up @@ -1181,7 +1181,7 @@
- Remove support for the value =all= for =dotspacemacs-configuration-layers=
variable. To install all the packages supported by Spacemacs there is a new
variable =dotspacemacs-install-packages=.
- Remove layer variable =colors-enable-rainbow-identifiers= in =colors= layer,
- Remove layer variable =colors-enable-rainbow-identifiers= in =colors= layer,
You have to replace it by =colors-colorize-identifiers 'all=.
- The =bépo= layer has been replaced by the new layer =keyboard-layout=, see the
=README.org= of the layer for more info.
Expand Down Expand Up @@ -1344,7 +1344,7 @@
is set to =origami=) (thanks to ralesi)
- Add package =link-hint=:
- ~SPC x o~ to use avy to select a link in the frame and open it
- ~SPC x O~ to use avy to select multiple links in the frame and open them
- ~SPC x O~ to use avy to select multiple links in the frame and open them

(thanks to StreakyCobra)
- Add package =uuidgen=:
Expand Down Expand Up @@ -2259,7 +2259,7 @@

**** Old
- Fabien Dubosson (StreakyCobra)
- Justin Burkett (thanks to justbur)
- Justin Burkett (thanks to justbur)

* Release 0.105.x
** 0.105.22 (2016/08/19)
Expand Down Expand Up @@ -3077,7 +3077,7 @@ Improve loading robustness:
- New key binding ~SPC m x x~ to run =go run= for the current main package
(thanks to sectorzero)
- New key bindings for testing:
- ~SPC m t P~ to run =go test= for the current package and all packages under it |
- ~SPC m t P~ to run =go test= for the current package and all packages under it |
- ~SPC m t t~ to run =go test= for the function you’re currently in
and ~SPC m t s~ to run =go test= for the suite you’re currently in

Expand Down Expand Up @@ -3265,7 +3265,7 @@ Improve loading robustness:
**** Rust
- New key binding ~SPC m c C~ to remove build artefacts with Cargo
(thanks to SShrike)
- New key binding ~SPC m g g~ to jump to definition (thanks to isphinx)
- New key binding ~SPC m g g~ to jump to definition (thanks to isphinx)
- Use =exec-path-from-shell-copy-env= to set =RUST_SRC_PATH= for Racer
(thanks to mahinshaw)

Expand Down Expand Up @@ -3325,7 +3325,7 @@ Improve loading robustness:
- Enable new global minor mode =flycheck-pos-tip-mode= (thanks to StreakyCobra)
- New key bindings ~SPC e s~ and ~SPC e S~ to select =flycheck= checker
executable (thanks to nashamri)
- Fix escaping in buffer name regexp (thanks to lunaryorn)
- Fix escaping in buffer name regexp (thanks to lunaryorn)
- Remove flycheck fringe’s bullet underlines (thanks to StreakyCobra)

**** Themes-megapack
Expand Down Expand Up @@ -4361,7 +4361,7 @@ Improve loading robustness:
- New variable =osx-use-option-as-meta= allowing to enable or disable the
mapping of =option= key to =meta= key. This is especially useful for some
European keyboard layouts like Finish or Swedish (thanks to tko)
- Add ~⌘ +~ and ~⌘ -~ key bindings to scale text (thanks to JoshTGreenwood
- Add ~⌘ +~ and ~⌘ -~ key bindings to scale text (thanks to JoshTGreenwood
and zimbatm)
- Only update =dired-use-ls-dired= if =gls= was found on path (thanks to
usharf)
Expand Down Expand Up @@ -4568,7 +4568,7 @@ Improve loading robustness:
automatically uninstalled).
- Don’t use the minibuffer for =scroll= micro-state
- Don’t close compilation buffer after success (thanks to TheBB)
- Make =trailing-whitespace= face more subtle (thanks to tuhdo)
- Make =trailing-whitespace= face more subtle (thanks to tuhdo)
- Beautify whitespace highlighting (thanks to tuhdo)
- Make inactive window face of mode-line compatible with more themes
(thanks to tuhdo)
Expand Down Expand Up @@ -4899,7 +4899,7 @@ Improve loading robustness:
* Release 0.101.x
** Hot new features
*** Choose your own editing style
Thanks to the new =holy-mode= Spacemacs can now be used by Vim users
Thanks to the new =holy-mode= Spacemacs can now be used by Vim users
or Emacs users by setting the =dotspacemacs-editing-style= variable to
='vim= or ='emacs= in the dotfile. In =Emacs= style the leader is
available on =M-m=. It is possible to dynamically switch between the
Expand All @@ -4911,7 +4911,7 @@ A package is now considered to be used only if there is a corresponding
There is now two new functions to initialize a given package:
- =<layer>/pre-init-<package>= which is called before the init function
- =<layer>/post-init-<package>= which is called after the init function
Even if a =pre= or =post= function exist for a given package, an =init=
Even if a =pre= or =post= function exist for a given package, an =init=
function is still required to consider the package to be used.

*** Auto-completion
Expand Down Expand Up @@ -4964,7 +4964,7 @@ a batch of packages.
- =dotspacemacs-verbose-loading= if non nil the loading prints logs in
the =*Messages*= buffer. Default value is =nil=.
- =dotspacemacs-startup-lists= is a list of symbols to display recent
items in the startup buffer, possible values are: =recents=,
items in the startup buffer, possible values are: =recents=,
=bookmarks= and =projects= (thanks to CarlQLange)

*** Auto-complete
Expand Down Expand Up @@ -5044,7 +5044,7 @@ a batch of packages.
- Add function =spacemacs/helm-projectile-search-dwim= which select the
first available external search tool (pt, ag, ack or grep) (thanks to
ralesi)
- Enable =helm-descbinds= globally (thanks to tuhdo)
- Enable =helm-descbinds= globally (thanks to tuhdo)
- Add key bindings for useful Helm commands: =helm-info-at-point=,
=helm-man-woman=, =helm-locate-library= and =helm-minibuffer-history=
(thanks to tuhdo)
Expand All @@ -5058,7 +5058,7 @@ a batch of packages.
- rcirc: Create rcirc logging directory during init
(thanks to jcpetkovich)
- New ERC layer (thanks to swaroopch)
- Add ERC keybindings (thans to cpaulik)
- Add ERC key bindings (thans to cpaulik)
- Move startup key bindings to prefix ~SPC a i~

*** Markdown
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.org
Expand Up @@ -28,7 +28,7 @@ Thanks! :heart: :heart: :heart:
- [[#file-header][File header]]
- [[#author-of-a-new-layer][Author of a new layer]]
- [[#contributor-to-an-existing-layer][Contributor to an existing layer]]
- [[#contributing-a-keybinding][Contributing a keybinding]]
- [[#contributing-a-key-binding][Contributing a key binding]]
- [[#contributing-a-banner][Contributing a banner]]
- [[#reviewing-pull-requests][Reviewing Pull Requests]]
- [[#using-magit-to-quickly-test-prs][Using Magit to quickly test PRs]]
Expand Down Expand Up @@ -205,10 +205,10 @@ name.
If you are contributing to an already existing layer, you should not modify any
header file.

** Contributing a keybinding
Keybindings are an important part of spacemacs.
** Contributing a key binding
Key bindings are an important part of spacemacs.

First if you want to have some personal keybindings, you can freely bind them
First if you want to have some personal key bindings, you can freely bind them
inside the ~SPC o~ and ~SPC m o~ prefixes which are reserved for the user. This
can be done from the =dotspacemacs/user-config= function of your =.spacemacs=
file and don’t require any contribution to Spacemacs.
Expand All @@ -217,9 +217,9 @@ If you think it worth contributing a new key bindings then be sure to read
the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/CONVENTIONS.org][CONVENTIONS.org]] file to find the best key bindings, then create a
PR with your changes.

*ALWAYS* document your new keybindings or keybindings changes inside the
*ALWAYS* document your new key bindings or key bindings changes inside the
relevant documentation file. It should be the layer’s =README.org= file for
layer’s keybindings, or =DOCUMENTATION.org= for general Spacemacs key
layer’s key bindings, or =DOCUMENTATION.org= for general Spacemacs key
bindings.

** Contributing a banner
Expand Down
10 changes: 5 additions & 5 deletions doc/BEGINNERS_TUTORIAL.org
Expand Up @@ -4,7 +4,7 @@
- [[#why-spacemacs][Why Spacemacs?]]
- [[#installation-and-setup][Installation and setup]]
- [[#getting-started][Getting started]]
- [[#keybinding-notation][Keybinding notation]]
- [[#key-binding-notation][Key binding notation]]
- [[#modal-text-editing---why-and-how][Modal text editing - why and how?]]
- [[#start-the-vim-tutorial][Start the Vim tutorial]]
- [[#using-the-spacebar-to-launch-commands][Using the spacebar to launch commands]]
Expand Down Expand Up @@ -35,9 +35,9 @@ and then download the Spacemacs extension files, which is most easily done by
using a program called Git. The steps are easy and detailed in the [[https://github.com/syl20bnr/spacemacs/blob/master/README.md#prerequisites][readme]].

* Getting started
** Keybinding notation
The power of Spacemacs lies in its efficient keybindings. Because it is built on
Emacs, we will use Emacs conventions for keybinding notation. The most important
** Key binding notation
The power of Spacemacs lies in its efficient key bindings. Because it is built on
Emacs, we will use Emacs conventions for key binding notation. The most important
modifier keys are:

~SPC~ = ~Space~, used as the leader key in Vim editing style.
Expand Down Expand Up @@ -249,7 +249,7 @@ more about the daemon and how to set it to launch automatically on startup.
This is useful outside of Spacemacs as well!

** Troubleshooting and further info
~SPC ?~ shows you the keybindings in the current major mode, which is often
~SPC ?~ shows you the key bindings in the current major mode, which is often
helpful. For troubleshooting, please refer to the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/FAQ.org][FAQ]] by pressing ~SPC h f~.
More help is found under ~SPC h~, and with ~SPC h ~SPC~ you can access the
comprehensive Spacemacs documentation, including this tutorial and the layer
Expand Down
2 changes: 1 addition & 1 deletion doc/CONVENTIONS.org
Expand Up @@ -201,7 +201,7 @@ History navigation in shells or REPLs buffers should be bound as well to
| Key | Description |
|-------+----------------------------|
| ~C-j~ | next item in history |
| ~C-k~ | previous item in history |
| ~C-k~ | previous item in history |
| ~C-l~ | clear screen |
| ~C-r~ | search backward in history |

Expand Down
72 changes: 36 additions & 36 deletions doc/DOCUMENTATION.org
Expand Up @@ -842,7 +842,7 @@ Spacemacs has 10 states:
*Note*: Technically speaking there is also the =operator= evil state.

** Evilified modes
Some buffers are not for editing text and provide their own keybindings for
Some buffers are not for editing text and provide their own key bindings for
certain operations. These often conflict with Vim bindings. To make such buffers
behave more like Vim in a consistent manner, they use a special state called
/evilified/ state. In evilified state, a handful of keys work as in Evil, namely
Expand Down Expand Up @@ -2069,29 +2069,29 @@ Spacemacs comes with a built-in port of [[https://github.com/tpope/vim-unimpaire
This plugin provides several pairs of bracket maps using ~[~ to denote
previous, and ~]~ as next.

| KeyBindings | Description |
|-------------+----------------------------------|
| ~[ SPC~ | Insert space above |
| ~] SPC~ | Insert space below |
| ~[ b~ | Go to previous buffer |
| ~] b~ | Go to next buffer |
| ~[ f~ | Go to previous file in directory |
| ~] f~ | Go to next file in directory |
| ~[ l~ | Go to the previous error |
| ~] l~ | Go to the next error |
| ~[ h~ | Go to the previous vcs hunk |
| ~] h~ | Go to the next vcs hunk |
| ~[ q~ | Go to the previous error |
| ~] q~ | Go to the next error |
| ~[ t~ | Go to the previous frame |
| ~] t~ | Go to the next frame |
| ~[ w~ | Go to the previous window |
| ~] w~ | Go to the next window |
| ~[ e~ | Move line up |
| ~] e~ | Move line down |
| ~[ p~ | Paste above current line |
| ~] p~ | Paste below current line |
| ~g p~ | Select pasted text |
| Key bindings | Description |
|--------------+----------------------------------|
| ~[ SPC~ | Insert space above |
| ~] SPC~ | Insert space below |
| ~[ b~ | Go to previous buffer |
| ~] b~ | Go to next buffer |
| ~[ f~ | Go to previous file in directory |
| ~] f~ | Go to next file in directory |
| ~[ l~ | Go to the previous error |
| ~] l~ | Go to the next error |
| ~[ h~ | Go to the previous vcs hunk |
| ~] h~ | Go to the next vcs hunk |
| ~[ q~ | Go to the previous error |
| ~] q~ | Go to the next error |
| ~[ t~ | Go to the previous frame |
| ~] t~ | Go to the next frame |
| ~[ w~ | Go to the previous window |
| ~] w~ | Go to the next window |
| ~[ e~ | Move line up |
| ~] e~ | Move line down |
| ~[ p~ | Paste above current line |
| ~] p~ | Paste below current line |
| ~g p~ | Select pasted text |

*** Jumping, Joining and Splitting
The ~SPC j~ prefix is for jumping, joining and splitting.
Expand Down Expand Up @@ -2418,7 +2418,7 @@ navigate between =Emacs= and Spacemacs specific files.
| ~SPC f e v~ | display and copy the spacemacs version |

**** Browsing files in completion buffer
In =vim= style and =hybrid= style with the variable
In =vim= style and =hybrid= style with the variable
=hybrid-mode-enable-hjkl-bindings= set to =t=, you can navigation with ~hjkl~.

| Key Binding | Description |
Expand Down Expand Up @@ -2963,7 +2963,7 @@ argument (i.e. ~10 SPC n +~ will add 10 to the number under point).
Spell checking is enabled by including the [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bcheckers/spell-checking/README.org][spell
checking]] layer in your dotfile.

Keybindings are listed in the layer documentation.
Key bindings are listed in the layer documentation.

*** Region selection
Vi =Visual= modes are all supported by =evil=.
Expand Down Expand Up @@ -3142,7 +3142,7 @@ The key bindings start with ~SPC x r~ and have the following mnemonic structure:
| ~SPC x r /~ | Explain the regexp around point with =rx= |
| ~SPC x r '​~ | Generate strings given by a regexp given this list is finite |
| ~SPC x r t~ | Replace regexp around point by the =rx= form or vice versa |
| ~SPC x r x~ | Convert regexp around point in =rx= form and display the result in the minibuffer |
| ~SPC x r x~ | Convert regexp around point in =rx= form and display the result in the minibuffer |
| ~SPC x r c~ | Convert regexp around point to the other form and display the result in the minibuffer |
| ~SPC x r e /~ | Explain Emacs Lisp regexp |
| ~SPC x r e '​~ | Generate strings from Emacs Lisp regexp |
Expand Down Expand Up @@ -3418,15 +3418,15 @@ variable =dotspacemacs-persistent-server= to =t= in your =~/.spacemacs=.
When this variable is set to =t=, the only way to quit Emacs /and/ kill the
server is to use the following bindings:

| Keybinding | Description |
|------------+--------------------------------------------------------------------------|
| ~SPC q q~ | Quit Emacs and kill the server, prompt for changed buffers to save |
| ~SPC q Q~ | Quit Emacs and kill the server, lose all unsaved changes. |
| ~SPC q r~ | Restart both Emacs and the server, prompting to save any changed buffers |
| ~SPC q s~ | Save the buffers, quit Emacs and kill the server |
| ~SPC q f~ | Kill the current frame |
| ~SPC q t~ | Restart Emacs and debug with --with-timed-requires |
| ~SPC q T~ | Restart Emacs and debug with --adv-timers |
| Key binding | Description |
|-------------+--------------------------------------------------------------------------|
| ~SPC q q~ | Quit Emacs and kill the server, prompt for changed buffers to save |
| ~SPC q Q~ | Quit Emacs and kill the server, lose all unsaved changes. |
| ~SPC q r~ | Restart both Emacs and the server, prompting to save any changed buffers |
| ~SPC q s~ | Save the buffers, quit Emacs and kill the server |
| ~SPC q f~ | Kill the current frame |
| ~SPC q t~ | Restart Emacs and debug with --with-timed-requires |
| ~SPC q T~ | Restart Emacs and debug with --adv-timers |

** Disabling the Emacs server
You can disable the built-in server by setting the variable
Expand Down
2 changes: 1 addition & 1 deletion doc/LAYERS.org
Expand Up @@ -545,7 +545,7 @@ In =:config= should be
- Anything that takes a long time to run, which would ruin startup performance.

The =:init= block should contain setup for the entry points to the package. This
includes keybindings, if the package should be loaded manually by the user, or
includes key bindings, if the package should be loaded manually by the user, or
hooks, if the package should be loaded upon some event. It is not unusual to
have both!

Expand Down

0 comments on commit 901f358

Please sign in to comment.