diff options
| author | Tomas Volf <~@wolfsden.cz> | 2024-03-14 17:45:04 +0100 |
|---|---|---|
| committer | Tomas Volf <~@wolfsden.cz> | 2024-03-14 17:45:04 +0100 |
| commit | 2cccde1e3fb493ae4b1d523029b0b361080902d8 (patch) | |
| tree | 4e0d3347b30788d001d0750a1ea08b6b29a59450 /geiser-guile.texi | |
| parent | 635d312b9084fa2d4eea4b57f20a7ad5197da2ba (diff) | |
| download | geiser-guile-2cccde1e3fb493ae4b1d523029b0b361080902d8.tar.gz geiser-guile-2cccde1e3fb493ae4b1d523029b0b361080902d8.tar.bz2 | |
Allow processing of texinfo in docstrings.
This commit adds support for processing texinfo in docstrings. That allows
using texinfo in them while still having readable, nicely formatted plain text
representation in geiser-doc-symbol-at-point.
Fixes #43.
* geiser-guile.el (geiser-guile-doc-process-texinfo): New custom controlling the
behavior.
(geiser-guile-update-doc-process-texinfo): New procedure to apply change of the
controlling custom to a current REPL.
(geiser-guile--startup): Call it.
* geiser-guile.texi (Start up): Document the custom.
* src/geiser/doc.scm (%process-texinfo?): New variable.
(try-texinfo->plain-text): New procedure.
(docstring): Call it on doc iff doc.
Diffstat (limited to 'geiser-guile.texi')
| -rw-r--r-- | geiser-guile.texi | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/geiser-guile.texi b/geiser-guile.texi index af87d34..ae605ab 100644 --- a/geiser-guile.texi +++ b/geiser-guile.texi @@ -73,6 +73,11 @@ loading @samp{~/.guile}, leave @code{geiser-guile-init-file} alone and set One can also provide a global list of paths to add to Guile's @samp{%load-path} via @code{geiser-guile-load-path}. +You can enable processing of texinfo in docstrings by customizing +@code{geiser-guile-doc-process-texinfo} to a non-nil value. If +enabled and docstring is a valid texinfo snippet, it will be converted +into a plain text before being displayed. + @node Debugging support @unnumbered Debugging support @@ -99,4 +104,4 @@ Geiser guile can be used remotely via tramp connections: the REPL process will be run in the machine where the tramp-accessed file lives. Implemented by Felipe Lema. -@bye
\ No newline at end of file +@bye |