The convention is documented in the section you already referenced (Tips for Documentation Strings). The purpose of the quotes is mentioned, and examples are provided:
Help mode automatically creates a hyperlink when a documentation
string uses a symbol name inside single quotes ... For example, if
This function sets the variable `buffer-...
Apropos help in Emacs is by no means limited to function apropos.
M-x apropos documentation. It lets you match keywords or a regexp against doc strings. Very helpful when you don't know how the function might be named but you might be able to guess some words used in its doc.
For example, M-x apropos-documentation RET shift bit RET shows you the names and ...
When in a certain buffer one can use M-x org-store-link to find the correct syntax for linking to that file.
For linking to internal documentation you can use the following links:
The first will take you to the Elisp Intro, the second to the Reference Manual.
Whenever you may wish to link to an info document, use the ...
Included with emacs is a basic tool called picture-mode:
To edit a picture made out of text characters (for example, a picture of
the division of a register into fields, as a comment in a program), use
the command ‘M-x picture-mode’ to enter Picture mode.
In Picture mode, editing is based on the “quarter-plane” model of
text, according to which ...
You've seen the basics, really. Your main problem was that this documentation was wrong, not that you weren't looking in the right place.
The slightly more direct way to read that documentation for a mode is by calling describe-function:
And the bit you missed is that, should the mode in question be indexed in the manual, you can ...
It sounds as if the dir file within your info directories don't contain all the nodes that it should. You can verify this by looking at the contents of the file /usr/share/info/emacs-24/dir (if this is the directory that's lacking entries).
Normally, this file will be updated by the program that installs the info file, but you can also do it manually. If ...
I can add not an exact answer to your question, but a workflow that eliminates the need for it.
I use smex instead of execute-extended-command.
Once in the minibuffer of smex:
RET calls execute-extended-command
C-h f calls smex-describe-function
M-. calls smex-find-function
I don't like the default bindings, so I've customized them:
I don't see a way built in to company-mode to do this, but you can add your own key binding to company-active-map.
As a quick experiment I took the company-show-doc-buffer implementation and simply removed the company--electric-do wrapper:
(defun my/company-show-doc-buffer ()
"Temporarily show the documentation buffer for the selection."
Indeed it does accomplish that behavior using overlays. Specifically- it uses the 'after-string property to show the documentation (see: Overlay Properties).
If you examine the function company-coq--show-definition-overlay-at-point (ex: via M-x find-function) you can see exactly how it's created:
(setq company-coq-definition-overlay (make-overlay ins-pos ...
The "easiest way" is to just define your own version of describe-function, and bind that to C-h f.
Take the vanilla code, and change only the call to completing-read so that it uses the same history list that M-x (execute-extended-command) uses, which is extended-command-history.
(defun my-describe-function (function)
"Display the full documentation of ...
Please note that it's very easy to invoke the command from its Help buffer. After typing C-h f just type M-x M-n RET. This works because in a new Help buffer the command name is at the top of the buffer under the cursor, and M-n retrieves it to the minibuffer.
However, if you want to add a command to extended-command-history every time you visit its ...
C-h i runs the info command by default, which searches for info files in Info-directory-list. If this is nil Info uses the environment variable INFOPATH or Info-default-directory-list if no INFOPATH variable is defined.
When the info files are not found it is possible that one or more of these values has been incorrectly customised.
That error is because the full documentation is not installed by default.
Solve it by installing emacs25-common-non-dfsg
# aptitude install emacs25-common-non-dfsg
Test it by trying,
C-h i h
It should now work.
You can use C-h o (describe-symbol) on Emacs 25, here is the related NEWS info:
Changes in Emacs 25.1
** New doc command `describe-symbol'. Works for functions, vars, faces, etc...
(It was originally called describe-function-or-variable according to this commit.)
Variable and function with the same name can be showed at the same time, for ...
Author's comment on a page comparing company-mode to auto-complete:
What happens when you press F1 in company mode
It uses pop-to-window to display the help buffer, but hides it before the next command (unless that command is scroll-other-window or scroll-other-window-down).
Based on that, you can only scroll the documentation buffer, not jump to it.
(defun modes-tree ()
with result = (make-hash-table)
for maybe-mode in (apropos-internal "-mode$")
;; This doesn't really filter all non-modes, but it gets close
when (fboundp maybe-mode) do
(setf (gethash maybe-mode result)
(get maybe-mode 'derived-mode-parent))
finally (cl-return result)))
Something to get you started....
Use Literate DevOps Method
I recommend using the literate devops method via org-mode, that @phils suggested in the comments, because of the ease of use and adaptable workflow.
Create or open an org-mode file to store an manage your notes and annotations. e.g. C-x C-f ex1-annotations.org
Add a new shell SRC code block using built-in easy ...
I was looking for the variable Info-hide-note-references. Specifically, setting it to 'hide results in the behavior I want. The Sphinx FAQ goes into more detail about this, and suggests the following advice to automatically enable this on sphinx-generated files (Fixed since the regex they suggest wasn't working)
(defvar-local Info-hide-note-references t)
(Please state your Emacs version, and name the Info node in question: Adjusting Point.)
I am not sure those are the same things. If they are, I think they are not consistent expression, at least the former should be
text that has the ‘display’, ‘composition’ or ‘invisible’ properties.
You are exactly right: that is not grammatical English - ...
In answer to the question of how often the paper copy of the manual is updated, the kind folks in the FSF sales department responded with the following (circa late-October 2014 for future reference; quoted with their permission):
Thank you for supporting the Free Software Foundation.
So, we usually order a new version of the Emacs manual when the older ...
The Info (hypertext) manual that is distributed with Emacs and available from Emacs by C-h r is updated periodically by fixing doc bugs. It is also updated for each Emacs release, to be accurate with respect to changes in the program, including new features.
If you see something that needs to be improved, please file an enhancement request or bug report, ...
Judging by the issue, the author of this question expected to see the documentation for variables from a package that hasn't been loaded yet.
M-x describe-variable won't show it either, so it's not a bug.
Most commands are absolutely fine for both interactive and non-interactive use, so a default position of "if it doesn't say otherwise, it's ok for non-interactive use" is going to be fine in the majority of cases (and if you find undocumented cases where this is not so, you could submit a documentation bug report).
Documentation aside, I don't believe there ...
There are two issues here.
On the one hand, when a function is called, the arguments are evaluated first. But when you evaluate a macro, the arguments are not evaluated. Instead, they are used to expand the macro into a form, which is subsequently evaluated.
On the other hand, a form is just a single lisp object that is going to be evaluated, while a body ...
As of May 2016, for develop branch of Spacemacs, the command is helm-spacemacs-help-layers under Space h l (assuming Space is your leader key). It will open a Helm buffer with all layers available in your Spacemacs. Choose a layer, press Enter, and you will end up in the layer's README file.
Also, while still browsing the list of layers in Helm, press Ctrl+...
To search through documentation, you can use the command apropos-documentation, which is bound to C-h d by default.
The other apropos commands may be useful to you. You can use apropos to search for apropos functions by using apropos-command (bound to C-h a) and typing apropos RET.
There is also a Helm command called helm-apropos that will allow you to ...
elpy has a function elpy-open-and-indent-line-below which is binded to <S-return>.
After """, you can hit <S-return> to open new line and indent automatically. You can use this at the end of line.
Alternatively, you can bind return to this function.
(define-key elpy-mode-map (kbd "<return>") 'elpy-open-and-indent-line-below)