diff options
| -rw-r--r-- | geiser-guile.texi | 14 | ||||
| -rw-r--r-- | readme.org | 7 |
2 files changed, 16 insertions, 5 deletions
diff --git a/geiser-guile.texi b/geiser-guile.texi index ae605ab..8902a30 100644 --- a/geiser-guile.texi +++ b/geiser-guile.texi @@ -25,6 +25,7 @@ @menu * Overview:: * Start up:: +* Texinfo docstrings:: * Debugging support:: * Tramp support:: @end menu @@ -37,7 +38,7 @@ This package provides support for using @uref{https://www.gnu.org/software/guile Provided @uref{https://gitlab.com/emacs-geiser/geiser, geiser} is installed in your system, if this package's directory is in your load path, just add @code{(require 'geiser-guile)} to -your initialisation files and then @code{M-x run-guile} to start a REPL@. +your initialisation files and then @code{M-x geiser-guile} to start a REPL@. Scheme files with a Guile module declaration should be automatically recognised as Guile-flavoured Geiser buffers. @@ -68,15 +69,18 @@ to disable loading the second. But there are subtle differences in the way Guile loads the initialization file versus how it loads a file specified via the @samp{-l} flag. If what you want is just loading @samp{~/.guile}, leave @code{geiser-guile-init-file} alone and set -@code{geiser-guile-load-init-file-p} to @code{t} instead. +@code{geiser-guile-load-init-file} to @code{t} instead. One can also provide a global list of paths to add to Guile's @samp{%load-path} via @code{geiser-guile-load-path}. +@node Texinfo docstrings +@unnumbered Texinfo docstrings + 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. +@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 @@ -47,6 +47,13 @@ geiser-guile. One can also provide a global list of paths to add to Guile's =%load-path= via ~geiser-guile-load-path~. +* Texinfo docstrings + + You can enable processing of texinfo in docstrings by customizing + ~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. + * Debugging support Guile supports all the debugger commands supported by Geiser (it's |