Questions tagged [documentation]

The tag has no usage guidance.

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

Function that updates function documentation

Could the following command be put in a function that takes a function name (workbench) and a variable (workbench-usage) containing the usage string. (put 'workbench 'function-documentation (...
user avatar
  • 107
-1 votes
0 answers
21 views

Ways to store usage information outside a function, then appending to docstring

I am adding usage information to the function myfunc in this way. (defun myfunc-usage "Usage Information") (defun myfunc "Brief description\n\n" ...) (put 'myfunc '...
user avatar
  • 107
0 votes
1 answer
37 views

How do I get the Emacs Lisp Intro manual in my info system?

I recently switched to Doom Emacs and went to find the "Emacs Lisp Intro Manual", and it's not in there. Is there a way to add it? Or, am I just looking in the wrong place?
user avatar
0 votes
1 answer
49 views

Docstring - quotes or semicolons?

In the documentation I only see mention of using semicolons for comments and docstrings, but in elisp-documents I regularly see functions documented in double-quotes, such as in org.el: (defun org-...
user avatar
  • 224
0 votes
0 answers
37 views

Autogenerate HTML files out emacs help

Am I right to say that the content I read when doing C-h f foobar (or something like that) is read directly from the lisp sources? In Python I would call it docstrings. In Python I can use Sphinx, ...
user avatar
  • 509
0 votes
0 answers
33 views

Elpy cannot access Pydoc documentation for non-builtin packages

I am using Emacs 27.2 on up-to-date Fedora 34 and I installed Elpy from, as I recall, melpa. Python version (in /usr/bin/python) is 3.9.7. I am trying to use C-c C-d to access Python documentation. ...
user avatar
  • 33
1 vote
0 answers
36 views

How to start contributing to emacs manual

Actually I am thinking to contribute to emacs manual, Specially in eshell few sections are empty so. Just need some guidance/resource to refer to write in texinfo
user avatar
2 votes
1 answer
631 views

How was the Emacs Manual typed?

I have a beautiful hardcopy of the Emacs Manual printed by the FSF. I was wondering if anyone knew how this document was created in Emacs and what mode was used for its creation? I would also be ...
user avatar
  • 1,060
1 vote
1 answer
380 views

How to get help on Doom's own functions

I use describe-function command with SPC h f to get help on emacs functions. But I want to get documentation on Doom's own functions such as map!. describe-function doesn't list this function. How can ...
user avatar
0 votes
0 answers
12 views

Info-apropos within current manual

Info-apropos "grovels indices of all known Info files on your system for STRING" and builds a menu of the possible matches. However, with numerous manuals on my system, the process takes a ...
user avatar
  • 3,885
0 votes
1 answer
381 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 ...
user avatar
  • 825
1 vote
1 answer
50 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 ...
user avatar
1 vote
1 answer
40 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 ...
user avatar
  • 1,439
1 vote
2 answers
563 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 ...
user avatar
  • 883
0 votes
1 answer
125 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 ...
user avatar
5 votes
1 answer
733 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 | ...
user avatar
  • 1,089
8 votes
1 answer
232 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 ...
user avatar
  • 4,231
1 vote
0 answers
245 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 ...
user avatar
1 vote
0 answers
60 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 ...
user avatar
  • 201
0 votes
0 answers
125 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 ...
user avatar
2 votes
1 answer
232 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 ...
user avatar
  • 745
3 votes
2 answers
80 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’, ‘...
user avatar
  • 745
10 votes
1 answer
1k 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 ...
user avatar
5 votes
1 answer
52 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 ...
user avatar
  • 329
1 vote
0 answers
49 views

Open GNU Scientific Library Documentation within emacs?

How do I open documentation of the GNU Scientific Library within emacs?
user avatar
  • 223
4 votes
1 answer
145 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 ...
user avatar
1 vote
1 answer
248 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 ...
user avatar
2 votes
1 answer
213 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 ...
user avatar
6 votes
2 answers
332 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 ...
user avatar
1 vote
1 answer
268 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.
user avatar
  • 1,388
1 vote
2 answers
154 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 ...
user avatar
  • 113
0 votes
1 answer
91 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 ...
user avatar
  • 745
0 votes
1 answer
152 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) ...
user avatar
4 votes
2 answers
96 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 ...
user avatar
  • 6,681
10 votes
2 answers
801 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):
user avatar
  • 1,768
1 vote
1 answer
93 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 ...
user avatar
5 votes
1 answer
488 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. """ ...
user avatar
  • 173
5 votes
2 answers
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 ...
user avatar
2 votes
3 answers
733 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?
user avatar
  • 151
1 vote
1 answer
98 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 ...
user avatar
  • 1,475
2 votes
1 answer
396 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 ...
user avatar
  • 239
0 votes
1 answer
1k 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 ...
user avatar
  • 101
3 votes
1 answer
1k 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-...
user avatar
2 votes
1 answer
955 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?...
user avatar
  • 501
1 vote
1 answer
236 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 ...
user avatar
3 votes
2 answers
683 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-...
user avatar
  • 131
7 votes
1 answer
1k views

Meaning of CRM column in buffer list from `C-x C-b`?

In the Buffer List, I wonder what the CRM column means and ., *, % and D mean in the column? For example CRM Buffer Size Mode File . * .emacs 3294 Emacs-...
user avatar
  • 4,707
3 votes
1 answer
155 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: ...
user avatar
  • 3,132
8 votes
1 answer
350 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 ...
user avatar
1 vote
0 answers
242 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 ...
user avatar