summaryrefslogtreecommitdiff
path: root/geiser-guile.el
diff options
context:
space:
mode:
authorTomas Volf <~@wolfsden.cz>2024-03-14 17:45:04 +0100
committerTomas Volf <~@wolfsden.cz>2024-03-14 17:45:04 +0100
commit2cccde1e3fb493ae4b1d523029b0b361080902d8 (patch)
tree4e0d3347b30788d001d0750a1ea08b6b29a59450 /geiser-guile.el
parent635d312b9084fa2d4eea4b57f20a7ad5197da2ba (diff)
downloadgeiser-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.el')
-rw-r--r--geiser-guile.el25
1 files changed, 24 insertions, 1 deletions
diff --git a/geiser-guile.el b/geiser-guile.el
index ac5e6b4..7663b83 100644
--- a/geiser-guile.el
+++ b/geiser-guile.el
@@ -169,6 +169,14 @@ effect on new REPLs. For existing ones, use the command
"List of info nodes that, when present, are used for manual lookups."
:type '(repeat string))
+(geiser-custom--defcustom geiser-guile-doc-process-texinfo nil
+ "Non-nil means try to convert docstrings from texinfo into plain-text.
+
+Changes to the value of this variable will automatically take
+effect on new REPLs. For existing ones, use the command
+\\[geiser-guile-update-doc-process-texinfo]."
+ :type 'boolean)
+
;;; REPL support
@@ -570,6 +578,17 @@ The new level is set using the value of `geiser-guile-warning-level'."
(geiser evaluation))))
(geiser-eval--send/result code)))
+(defun geiser-guile-update-doc-process-texinfo ()
+ "Update whether docstrings should be processed as texinfo.
+The new value is set using the value of `geiser-guile-doc-process-texinfo'."
+ (interactive)
+ (let* ((new-value (if geiser-guile-doc-process-texinfo
+ '\#t
+ '\#f))
+ (code `(begin (set! (@@ (geiser doc) %process-texinfo?) ,new-value)
+ 'done)))
+ (geiser-eval--send/wait code)))
+
;;;###autoload
(defun connect-to-guile ()
"Start a Guile REPL connected to a remote process.
@@ -619,7 +638,11 @@ See `geiser-guile-use-declarative-modules'."
(dolist (dir g-load-path)
(let ((dir (expand-file-name dir)))
(geiser-eval--send/wait `(:eval (:ge add-to-load-path ,dir)))))
- (geiser-guile-update-warning-level)))
+ (geiser-guile-update-warning-level)
+ (let ((geiser-guile-doc-process-texinfo
+ (buffer-local-value 'geiser-guile-doc-process-texinfo
+ geiser-repl--last-scm-buffer)))
+ (geiser-guile-update-doc-process-texinfo))))
;;; Manual lookup