Questions tagged [documentation]

The tag has no usage guidance.

Filter by
Sorted by
Tagged with
0
votes
1answer
54 views

Getting Helm describe-function/describe-variable’s secondary to work like helm-M-x?

When you use Helm for M-x, you can quickly check the documentation for an interactive command before calling it, it using the secondary key (usually C-z or C-j; I use the latter below). It brings up a ...
0
votes
0answers
62 views

org-capture-template “:created” property

Studying the variable org-capture-template I found several configurations where a certain :created t property is used. One example is here In my help buffer (help:org-capture-templates) I could not ...
0
votes
1answer
30 views

Is there a way to generally search package or language documentation within emacs?

In this case, I'm most interested in Rust's documentation, which lives at doc.rust-lang.org/std. eww is incompatible with JS, so the documentation doesn't play nice, thus my general current soln is to ...
1
vote
1answer
14 views

List of hooks inhibited by inhibit-modification-hooks

The documentation of inhibit-modification-hooks states Non-nil means don't run any of the hooks that respond to buffer changes. This affects before-change-functions and after-change-functions, as ...
0
votes
2answers
141 views

Temporarily show the documentation for a emacs lisp function

I want to bind a key which when pressed shows the documentation for an emacs lisp function, but as non-disruptive as possible. I want the contents of describe-function but jumping directly to the docs ...
0
votes
1answer
54 views

emacs' internal documentation missing info?

Emacs 26.1 on Debian 10 stable I have previously used the Windows version of Emacs and now I'm back in Linux (thanks to it). When pressing C-h i d there seemed to be a lot of more information in the ...
5
votes
1answer
717 views

Are the graphical depictions in docs drawed in manual labour?

There are tons of pretty graphical depictions in the emacs(or elisp) docs such as x1: -------------- -------------- -------------- | car | cdr | | car | cdr | | car | ...
8
votes
1answer
142 views

How to discover (standard) function names?

When programing emacs (or common) lisp, how to discover (standard) function names (using emacs and working offline)? Example: Let's say you want to shift bits of an integer, but you don't now ...
1
vote
0answers
125 views

How do you guys use doxygen? [closed]

I'm curious about Doxygen, how do you guys manage documentation in C/C++ projects on emacs? I didn't find a good package that does it consistently. So far I did use gendoxy and doxymacs. I had ...
1
vote
0answers
56 views

Emacs plugin to browse Julia documentation, at point or textual

It is quite annoying that I have to leave emacs to browse Julia documentation. Are there any nice plugins to get the documentation at point or that provides a nice direct textual interface to the ...
0
votes
0answers
124 views

What features differentiate Spacemacs from other editors and IDEs in terms that someone unfamiliar with both Vim and Emacs can understand?

I am in the position of onboarding junior developers to Spacemacs but I am unable to find a detailed, canonical description of Spacemacs that is geared toward beginners. Specifically, I don't find ...
2
votes
1answer
185 views

Why Emacs using `dumping` during building?

I'm not a C programmer and I am reading the GNU Emacs Lisp manual. Something grabs my attention in E.1 Building Emacs is Emacs use dumping to get a executable program other than temacs. I am ...
3
votes
2answers
71 views

Confused by the Emacs Lisp doc : Adjusting Point After Commands

I am on the trip of reading GNU Emacs Lisp Manual, and section 20.6 has the following text: It is not easy to display a value of point in the middle of a sequence of text that has the ‘display’, ‘...
8
votes
1answer
764 views

In Org Mode, how do I link to internal documentation?

I want to create a clickable-link in my Org file directly to documentation built into Emacs. Is this possible to do? The documentation I want to link to are: Emacs Lisp Intro The GNU Emacs Lisp ...
5
votes
1answer
41 views

How to remove “see” from info links / cross-references?

I'm generating Django documentation to more easily reference it in Emacs. The obvious approach[^] results in cross-references having "see" prepended to them. E.g., the online documentation for Model ...
1
vote
0answers
46 views

Open GNU Scientific Library Documentation within emacs?

How do I open documentation of the GNU Scientific Library within emacs?
4
votes
1answer
113 views

EMACS shell mode that supports annotations

I often find myself doing things like installations or debugging where I would like to be able to work in shell mode but be able to insert annotations as I go. BBEdit has something like this but ...
1
vote
1answer
176 views

How do you navigate documentation in Emacs?

There is some manual I have accessed before on Emacs that described how to navigate the documentation and also how it was constructed. However, I have forgotten how to get there. From memory, the ...
2
votes
1answer
185 views

Documentation for mode-line-emphasis and mode-line-interactive

I'm seeing mode-line-emphasis and mode-line-inactive used in color themes to change the mode-line face value for used and unused buffers. describe-function and describe-variable don't have an entry ...
6
votes
2answers
278 views

How to view package Full Description (commentary section) inside Emacs

I'm looking for a way to visualize inside Emacs the Full Description of a package as shown in Elpa index page. For example the undo-tree package has a nice and comprehensive help page/description ...
1
vote
1answer
227 views

What's the format of a `package-desc` for `package-install`?

The documentation of package-install says: "Install the package PKG. PKG can be a package-desc [...]", but then it doesn't explain what is the format of a package-desc.
1
vote
2answers
120 views

gdb Info manual

I can't seem to find the gdb Info manual file on the gnu.org documentation page for gdb, which only seems to have a PDF version and an online version. I've found and manually installed several other ...
0
votes
1answer
59 views

How to install `*-utils` manuals in GNU Emacs on Mac OS X?

I've been using GNU manuals of core-utils and find-utils and so on in GNU Emacs when I am using GNU Linux. They are default after installing GNU Emacs on many GNU Linux distributions. After open GNU ...
0
votes
1answer
132 views

Unclear expectation of behavior from `scan-sexps`

The docstring of scan-sexps says: If the beginning or end is reached between groupings but before count is used up, nil is returned. Putting point (|) before the first element of a list: (|a b c) ...
4
votes
2answers
79 views

How can I record where a function is defined if it's done indirectly?

I've got a few functions in api-wrap.el that I'll refer to as 'macro code', here simplified to clarify the question: function (generate-form prefix kind &rest args) returns an unevaluated form ...
10
votes
2answers
649 views

How to display overlay like this screencast?

How to make an overlay in Emacs like the following (maybe it's not overlay, I don't know, it's from company-coq inline-docs):
1
vote
1answer
81 views

How to read proper formatted documentation for bookmark+ package?

I am trying to learn about the bookmark+ package. I installed the package from M-x list-packages and I am using Emacs 25.1. It looks like a great package, the only difficulty I have so far, is that ...
5
votes
1answer
370 views

Docstrings don't automatically indent themselves in elpy-mode. How do I fix this?

This is an example function that shows that docstrings do not automatically indent. def testing_docstring(): """ docstring is not indented automatically! Even after a newline. """ ...
3
votes
2answers
2k views

Get help for a package

Is there a way to get a quick help for a certain package? Something similar you get when you click package description in Paradox. I think it would be interesting a sort of doc package which get the ...
2
votes
3answers
285 views

How can I search through builtin documentation? [duplicate]

Emacs claims to be self explanatory, but I couldn't find a way, to search through the documentation. This leads to me searching always in google. So how can is search through documentation in emacs?
1
vote
1answer
73 views

Why some packages included with Emacs don't have their documentation in the main manual?

I wanted to read the Ido documentation offline from Emacs. I read in the NEWS file of Emacs 24.5 that since the 24.4 version an "Ido user manual is now included" (line 608). But it was not possible ...
2
votes
1answer
314 views

how to find non-interactive function equivalents of elisp interactive functions

In the description of the function goto-line in the built-in emacs documentation, I found the following at the end: This function is usually the wrong thing to use in a Lisp program. What you ...
0
votes
1answer
844 views

Doxygen support

I'm creating some doxygen in Emacs and I can't find any mode for this purpose. The only mode I found is the below project which seems too old (last release from 2007!). Do you any alternatives to this ...
2
votes
1answer
920 views

Help Buffer on Hover Possible?

I'm looking for something similar to Eldoc mode (hover over a function and the parameter list appears in the minibuffer), only I'd like to have a help buffer appear, as if I had just run describe-...
2
votes
1answer
896 views

Spacemacs layer documentation

In ~/.emacs.d/layers/.../any-given-layer there is almost always a README documenting this layer's functionality. Is there a key binding, or function that opens the README associated with a given layer?...
1
vote
1answer
177 views

How does (org-agenda-todo arg) work? What does the argument mean?

By trial and error I have found that in org-agenda (org-agenda-todo 'done) marks the entry at point as "DONE". Can you explain why? How can I modify the argument to the org-agenda-todo function (or ...
3
votes
2answers
511 views

How to configure emacs to show documentation alongside completions while using gocode?

I have been using gocode with emacs and it gives completions of functions. Is there any way to get emacs to show the documentation of those functions in a pop up too. I am using auto-complete with go-...
3
votes
1answer
94 views

FORM vs BODY in documentation?

Recently I was trapped by void-variable error on eval-after-load. That is not first time I forget to quote args like: (eval-after-load 'sql '(progn ...)) because eval-after-load docs say: ...
8
votes
1answer
247 views

Good ways to access documentation?

Emacs has self-documentation as one of its goals, and it achieves this pretty well for Emacs Lisp with commands like describe-variable, describe-function, etc. Packages like company-quickhelp make ...
1
vote
0answers
220 views

Disable popwin temporarily with pop-up documentation

Following this question about automatically displaying documentation in a pop-up window, I decided to give it a try based on existing work on Popup Help in Emacs Lisp and clippy. However, I've run ...
4
votes
1answer
904 views

Pop-up documentation with pos-tip or popup?

Is there a package to get a popup of the documentation for the thing at the point? Here's an example that flycheck uses.
3
votes
1answer
511 views

Finding the source file containing the definition of functions and variables

Is it possible to merge find-function and find-variable to a single find-function-or-variable to be able to search both functions and variables at the same time and going to their definition in the ...
2
votes
1answer
3k views

Documentation for Python with company

I'm using Emacs with company and company-quickhelp. This works fine for Elisp and Clojure. However, displaying the quickhelp popup (or function signature) in Python mode doesn't work. I installed ...
4
votes
2answers
2k views

C-h i *info* directory is nearly empty

My situation is similar to Info file emacs does not exist. I installed emacs24, emacs24-el, and emacs24-common-non-dfsg on Ubuntu 14.04. Unlike in that other question, C-h r does work for me and I do ...
1
vote
0answers
38 views

How to cross reference input method in docstring?

I'd like to cross reference an input method from a minor mode docstring: (define-derived-mode xxx ... "Super `xxx' derived mode. Cool to use with input method `my-magic-input-method'.") Now ...
9
votes
1answer
653 views

How to quote symbols in a documentation string?

In the Emacs Lisp documentation, I often come across quoted symbols like `buffer-file-name' inside docstrings. The intersting thing here is the style of quoting, by surrounding the symbol name with a ...
4
votes
1answer
571 views

How to look up documentation for a minor mode?

I just decided that I should try the outline-minor-mode for showing and hiding Emacs lisp defun definitions in an Emacs Lisp file. So I typed M-x outline-minor-mode and then I would like to get an ...
1
vote
2answers
970 views

Is there a mode to indent doxygen type comment block with function parameters?

Consider the following php function: public function test(array $a, SomeObject $b) { return 0; } I would like to automatically generate the following code block: /** * @param array $a * @...
4
votes
4answers
3k views

Info file emacs does not exist

When I type C-h r I get error: Debugger entered--Lisp error: (error "Info file emacs does not exist") signal(error ("Info file emacs does not exist")) error("Info file %s does not exist" "...
5
votes
1answer
1k views

Where is the python.el documentation?

I am using emacs-24.3, which comes with python.el and IPython support out of the box (or so they say). Is there documentation for this mode? Where can I find it?