org-src: Fix docstrings

* lisp/org-src.el (org-src-mode-hook):
(org-src-mode): Fix docstring.
(org-src-mode-map): Refactor.
This commit is contained in:
Nicolas Goaziou 2015-05-01 09:49:14 +02:00
parent 2777b3fd4c
commit 0046955e23

View file

@ -156,10 +156,10 @@ other-frame Use `switch-to-buffer-other-frame' to display edit buffer.
(defvar org-src-mode-hook nil
"Hook run after Org switched a source code snippet to its Emacs mode.
This hook will run
- when editing a source code snippet with \"C-c '\".
- When formatting a source code snippet for export with htmlize.
\\<org-mode-map>
This hook will run:
- when editing a source code snippet with \\[org-edit-special]
- when formatting a source code snippet for export with htmlize.
You may want to use this hook for example to turn off `outline-minor-mode'
or similar things which you want to have when editing a source code file,
@ -527,18 +527,23 @@ with \",*\", \",#+\", \",,*\" and \",,#+\"."
;;; Org src minor mode
(defvar org-src-mode-map (make-sparse-keymap))
(define-key org-src-mode-map "\C-c'" 'org-edit-src-exit)
(define-key org-src-mode-map "\C-c\C-k" 'org-edit-src-abort)
(define-key org-src-mode-map "\C-x\C-s" 'org-edit-src-save)
(defvar org-src-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-c'" 'org-edit-src-exit)
(define-key map "\C-c\C-k" 'org-edit-src-abort)
(define-key map "\C-x\C-s" 'org-edit-src-save)
map))
(define-minor-mode org-src-mode
"Minor mode for language major mode buffers generated by org.
\\<org-mode-map>
This minor mode is turned on in two situations:
- when editing a source code snippet with \"C-c '\".
- When formatting a source code snippet for export with htmlize.
There is a mode hook, and keybindings for `org-edit-src-exit' and
`org-edit-src-save'"
- when editing a source code snippet with \\[org-edit-special]
- when formatting a source code snippet for export with htmlize.
\\{org-src-mode-map}
See also `org-src-mode-hook'."
(when org-edit-src-persistent-message
(org-set-local
'header-line-format