From 0051aa73c4907728140f3c1f575c5f8057fd8351 Mon Sep 17 00:00:00 2001 From: syl20bnr Date: Sun, 21 Dec 2014 22:52:57 -0500 Subject: [PATCH] Update conventions for help/doc key bindings `m d` goes under help commands so it is now `m h d` --- contrib/auctex/packages.el | 2 +- contrib/lang/erlang-elixir/packages.el | 16 ++++++++-------- contrib/lang/ess/packages.el | 4 ++-- contrib/lang/html/packages.el | 2 +- contrib/lang/javascript/packages.el | 2 +- contrib/lang/python/extensions.el | 2 +- contrib/lang/python/packages.el | 2 +- contrib/lang/ruby/packages.el | 2 +- contrib/lang/windows-scripts/extensions.el | 2 +- contrib/usr/trishume/packages.el | 2 +- doc/CONVENTIONS.md | 11 ++++++----- spacemacs/keybindings.el | 3 +-- spacemacs/packages.el | 8 ++++---- 13 files changed, 29 insertions(+), 29 deletions(-) diff --git a/contrib/auctex/packages.el b/contrib/auctex/packages.el index 6be5b0ac1..3bcb18a10 100644 --- a/contrib/auctex/packages.el +++ b/contrib/auctex/packages.el @@ -55,7 +55,7 @@ "mpf" 'preview-cache-preamble "mpc" 'preview-clearout - "m?" 'TeX-doc ;; TeX-doc is a very slow function + "mhd" 'TeX-doc ;; TeX-doc is a very slow function ) (setq-default TeX-auto-save t) diff --git a/contrib/lang/erlang-elixir/packages.el b/contrib/lang/erlang-elixir/packages.el index 7231bdc2f..8ce687da9 100644 --- a/contrib/lang/erlang-elixir/packages.el +++ b/contrib/lang/erlang-elixir/packages.el @@ -79,14 +79,14 @@ must be defined in `dotspacemacs/init' function to take effect.") ;; (setq edts-log-level 'debug) ;; (setq edts-face-inhibit-mode-line-updates t) (evil-leader/set-key-for-mode 'erlang-mode - "md" 'edts-find-doc - "me" 'edts-code-next-issue - "mG" 'edts-find-global-function - "mg" 'edts-find-source-under-point - "mh" 'edts-find-header-source - "ml" 'edts-find-local-function - "mm" 'edts-find-macro-source - "mr" 'edts-find-record-source)))) + "me" 'edts-code-next-issue + "mGg" 'edts-find-global-function + "mGh" 'edts-find-header-source + "mGl" 'edts-find-local-function + "mGr" 'edts-find-record-source + "mg" 'edts-find-source-under-point + "mhd" 'edts-find-doc + "mm" 'edts-find-macro-source)))) (defun erlang-elixir/init-flycheck () (add-hook 'elixir-mode-hook 'flycheck-mode) diff --git a/contrib/lang/ess/packages.el b/contrib/lang/ess/packages.el index ba3b10ce9..989b6fec4 100644 --- a/contrib/lang/ess/packages.el +++ b/contrib/lang/ess/packages.el @@ -32,8 +32,8 @@ which require an initialization must be listed explicitly in the list.") "mp" 'ess-R-object-popup "mB" 'ess-eval-buffer-and-go "mb" 'ess-eval-buffer - "mD" 'ess-eval-function-or-paragraph-and-step - "md" 'ess-eval-region-or-line-and-step + "mhD" 'ess-eval-function-or-paragraph-and-step + "mhd" 'ess-eval-region-or-line-and-step "mL" 'ess-eval-line-and-go "ml" 'ess-eval-line "mR" 'ess-eval-region-and-go diff --git a/contrib/lang/html/packages.el b/contrib/lang/html/packages.el index ef4731102..2ff5e1f96 100644 --- a/contrib/lang/html/packages.el +++ b/contrib/lang/html/packages.el @@ -16,7 +16,7 @@ which require an initialization must be listed explicitly in the list.") :defer t :init (eval-after-load 'scss-mode - '(evil-leader/set-key-for-mode 'scss-mode "mh" 'helm-css-scss)))) + '(evil-leader/set-key-for-mode 'scss-mode "mg" 'helm-css-scss)))) (defun html/init-web-mode () (use-package web-mode diff --git a/contrib/lang/javascript/packages.el b/contrib/lang/javascript/packages.el index f0801bd36..9f2d359a5 100644 --- a/contrib/lang/javascript/packages.el +++ b/contrib/lang/javascript/packages.el @@ -125,7 +125,7 @@ which require an initialization must be listed explicitly in the list.") :config (progn (evil-leader/set-key-for-mode 'js2-mode "mc" 'tern-rename-variable) - (evil-leader/set-key-for-mode 'js2-mode "md" 'tern-get-docs) + (evil-leader/set-key-for-mode 'js2-mode "mhd" 'tern-get-docs) (evil-leader/set-key-for-mode 'js2-mode "mg" 'tern-find-definition) (evil-leader/set-key-for-mode 'js2-mode "mG" 'tern-find-definition-by-name) (evil-leader/set-key-for-mode 'js2-mode (kbd "m C-g") 'tern-pop-find-definition) diff --git a/contrib/lang/python/extensions.el b/contrib/lang/python/extensions.el index 1ef8669d7..45ca24cbc 100644 --- a/contrib/lang/python/extensions.el +++ b/contrib/lang/python/extensions.el @@ -50,7 +50,7 @@ (add-to-list 'evil-emacs-state-modes 'pylookup-mode) (evil-add-hjkl-bindings pylookup-mode-map 'emacs) (evil-leader/set-key-for-mode 'python-mode - "mD" 'pylookup-lookup) + "mhD" 'pylookup-lookup) (let ((dir (config-system/get-layer-property 'python :ext-dir))) (setq pylookup-dir (concat dir "/pylookup") diff --git a/contrib/lang/python/packages.el b/contrib/lang/python/packages.el index a077d742d..50d77575e 100644 --- a/contrib/lang/python/packages.el +++ b/contrib/lang/python/packages.el @@ -28,7 +28,7 @@ which require an initialization must be listed explicitly in the list.") :config (progn (evil-leader/set-key-for-mode 'python-mode - "md" 'anaconda-mode-view-doc + "mhd" 'anaconda-mode-view-doc "mg" 'anaconda-mode-goto) (spacemacs|hide-lighter anaconda-mode)))) diff --git a/contrib/lang/ruby/packages.el b/contrib/lang/ruby/packages.el index 4ceecca0d..a993deea7 100644 --- a/contrib/lang/ruby/packages.el +++ b/contrib/lang/ruby/packages.el @@ -33,7 +33,7 @@ which require an initialization must be listed explicitly in the list.") :defer t :init (add-hook 'enh-ruby-mode-hook 'robe-mode) :config (progn (evil-leader/set-key-for-mode 'enh-ruby-mode "mg" 'robe-jump) - (evil-leader/set-key-for-mode 'enh-ruby-mode "md" 'robe-doc) + (evil-leader/set-key-for-mode 'enh-ruby-mode "mhd" 'robe-doc) (evil-leader/set-key-for-mode 'enh-ruby-mode "mR" 'robe-rails-refresh) (evil-leader/set-key-for-mode 'enh-ruby-mode "mi" 'robe-start)))) diff --git a/contrib/lang/windows-scripts/extensions.el b/contrib/lang/windows-scripts/extensions.el index 9570a2804..f740933c6 100644 --- a/contrib/lang/windows-scripts/extensions.el +++ b/contrib/lang/windows-scripts/extensions.el @@ -19,7 +19,7 @@ (add-hook 'outline-mode-hook 'windows-scripts/dos-outline-hook)) :config (evil-leader/set-key-for-mode 'dos-mode - "mD" 'dos-help-cmd + "mhD" 'dos-help-cmd "meb" 'dos-run "meB" 'dos-run-args "ms" 'dos-sep diff --git a/contrib/usr/trishume/packages.el b/contrib/usr/trishume/packages.el index 4d69cd06b..534d63ea1 100644 --- a/contrib/usr/trishume/packages.el +++ b/contrib/usr/trishume/packages.el @@ -63,7 +63,7 @@ "ml" 'evil-lisp-state "mt" 'racket-test "mg" 'racket-visit-definition - "md" 'racket-doc) + "mhd" 'racket-doc) (add-hook 'racket-mode-hook '(lambda () (define-key racket-mode-map (kbd "H-r") 'racket-run)))))) diff --git a/doc/CONVENTIONS.md b/doc/CONVENTIONS.md index abb6ab9b6..977f505fb 100644 --- a/doc/CONVENTIONS.md +++ b/doc/CONVENTIONS.md @@ -16,7 +16,7 @@ - [Depending on the language](#depending-on-the-language) - [Debugging](#debugging) - [Code navigation](#code-navigation) - - [Documentation](#documentation) + - [Getting Help or Documentation](#getting-help-or-documentation) - [Evilify buffers](#evilify-buffers) - [Navigation in `insert state` buffers](#navigation-in-insert-state-buffers) @@ -117,13 +117,14 @@ or more bindings for the same thing ------------------|------------------------------------------------------------ m g | go to definition of thing under point -### Documentation +### Getting Help or Documentation + +The base prefix for help commands is SPC h. Documentation is +considered as an help command. Key | Description ------------------|------------------------------------------------------------ -m d | documentation of thing under point - -**TBD** +m h d | documentation of thing under point ### Evilify buffers diff --git a/spacemacs/keybindings.el b/spacemacs/keybindings.el index f830cec2f..361db1885 100644 --- a/spacemacs/keybindings.el +++ b/spacemacs/keybindings.el @@ -170,8 +170,7 @@ "xgl" 'set-google-translate-languages) ;; Lisps ---------------------------------------------------------------------- (evil-leader/set-key-for-mode 'emacs-lisp-mode - "mD" 'elisp-slime-nav-describe-elisp-thing-at-point + "mhd" 'elisp-slime-nav-describe-elisp-thing-at-point "mg" 'elisp-slime-nav-find-elisp-thing-at-point - "mhv" 'describe-variable "mta" 'spacemacs/ert-run-tests-buffer "mtf" 'ert) diff --git a/spacemacs/packages.el b/spacemacs/packages.el index 90fc668fb..d2bab39d5 100644 --- a/spacemacs/packages.el +++ b/spacemacs/packages.el @@ -1145,10 +1145,10 @@ determine the state to enable when escaping from the insert state.") "Initialize helm-eshell." ;; this is buggy for now ;; (define-key eshell-mode-map (kbd "") 'helm-esh-pcomplete) - (evil-leader/set-key-for-mode 'eshell-mode "mh" 'spacemacs/helm-eshell-history)) + (evil-leader/set-key-for-mode 'eshell-mode "mH" 'spacemacs/helm-eshell-history)) (add-hook 'eshell-mode-hook 'spacemacs/init-helm-eshell) ;;shell - (evil-leader/set-key-for-mode 'shell-mode "mh" 'spacemacs/helm-shell-history) + (evil-leader/set-key-for-mode 'shell-mode "mH" 'spacemacs/helm-shell-history) (eval-after-load "helm-mode" ; required '(spacemacs|hide-lighter helm-mode))))) @@ -1304,8 +1304,8 @@ determine the state to enable when escaping from the insert state.") (progn (setq ledger-post-amount-alignment-column 62) (evil-leader/set-key-for-mode 'ledger-mode - "md" 'ledger-delete-current-transaction - "ma" 'ledger-add-transaction)))) + "mhd" 'ledger-delete-current-transaction + "ma" 'ledger-add-transaction)))) (defun spacemacs/init-leuven-theme () (use-package leuven-theme