this post was submitted on 26 Nov 2023
2 points (100.0% liked)

Emacs

313 readers
2 users here now

A community for the timeless and infinitely powerful editor. Want to see what Emacs is capable of?!

Get Emacs

Rules

  1. Posts should be emacs related
  2. Be kind please
  3. Yes, we already know: Google results for "emacs" and "vi" link to each other. We good.

Emacs Resources

Emacs Tutorials

Useful Emacs configuration files and distributions

Quick pain-saver tip

founded 1 year ago
MODERATORS
rglullis
raphael
2
calc's elisp function documentation. (alien.top)
submitted 1 year ago by SlowValue@alien.top to c/emacs
2 comments fedilink hide all child comments
 

Calc'c elisp functions (imho) all have the prefix calcFunc-. So in order to use a calc function like vlen in an org table lisp formula, one could use calcFunc-vlen. That's nice.

What bothers me is the lack of "on-line" documentation (i.e. usable with eldoc or completion frameworks).

All calc functions are nicely documented here: https://www.gnu.org/software/emacs/manual/html_mono/calc.html , thats good.

It is possible to modify a elisp's function documentation. e.g. like so:

(put 'calcFunc-vlen 'function-documentation
     "Computes the length of a vector.
The length of a non-vector is considered to be zero.
Note that matrices are just vectors of vectors for the purposes of this command.")

Now calcFunc-vlen would have a nice "on-line" documentation, usable with C-h f, autocompletion and eldoc.

Has anyone already bothered to gather some of those strings from the manual, in a more machine processable form? So I could save some work to create "on-line" documentation of the calc functions?

top 2 comments
sorted by: hot top controversial new old
[–] Ok_Advisor1053@alien.top 1 points 1 year ago (1 children)

You can use the helpful library, which puts links to the calc manual in the function documentation, among other things. What you call online documentation is just the package manual.

[–] SlowValue@alien.top 1 points 1 year ago

Thanks for your answer, though it does not help me with the issue (read below , why). I updated my question with screenshots.

What you call online documentation is just the package manual.

I wrote "on-line" within quotation marks. What I called "on-line" documentation is the function documentation (aka docstring). But I feared, when I would use function documentation every one would point me to the official calc manual ...
"On-line documentation" is (imho) just 1980s terminology for documentation readable within the program.

[...] helpful [...] puts links to the calc manual in the function documentation [...].

I updated my Question with screenshots, those screenshots are intended to make it more clear. Using helpful's WWW link in an emacs help buffer is like walking to the public library and reading a book (for my intended use case). (Don't get me wrong, reading a book from a public library is nice, I'm glad such things are possible.)