summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2010-08-11 22:41:14 +0200
committerJose Antonio Ortega Ruiz <jao@gnu.org>2010-08-11 22:41:14 +0200
commit739dde06bdd997995873fcd59f2c1cc1d2976aef (patch)
treefc889c41397b05998bd8e88a5e58a374484dd729 /doc
parentebec43db543a00efa13948f46fa30864844859fe (diff)
downloadgeiser-chez-739dde06bdd997995873fcd59f2c1cc1d2976aef.tar.gz
geiser-chez-739dde06bdd997995873fcd59f2c1cc1d2976aef.tar.bz2
More docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/fun.texi50
-rw-r--r--doc/img/docstring.pngbin0 -> 16390 bytes
-rw-r--r--doc/repl.texi1
3 files changed, 41 insertions, 10 deletions
diff --git a/doc/fun.texi b/doc/fun.texi
index 4b3e946..13c5c72 100644
--- a/doc/fun.texi
+++ b/doc/fun.texi
@@ -16,11 +16,10 @@ process giving you the REPL, make those Scheme buffers come to life.
@menu
* Activating Geiser::
* The source and the REPL::
-* Autodoc redux::
+* Documentation helpers::
* Evaluating Scheme code::
* Jumping around::
* Geiser writes for you::
-* In good company::
@end menu
@node Activating Geiser, The source and the REPL, Fun between the parens, Fun between the parens
@@ -72,7 +71,7 @@ provides require a REPL up and running, preferably corresponding to the
correct Scheme implementation. In the following section, we'll see how
to make sure that that's actually the case.
-@node The source and the REPL, Autodoc redux, Activating Geiser, Fun between the parens
+@node The source and the REPL, Documentation helpers, Activating Geiser, Fun between the parens
@section The source and the REPL
As i've already mentioned a couple of times, @i{geiser-mode} needs a
@@ -189,8 +188,10 @@ Now that we have @code{geiser-mode} happily alive in our Scheme buffers
and communicating with the right REPL instance, let us see what it can
do for us, besides jumping to and fro.
-@node Autodoc redux, Evaluating Scheme code, The source and the REPL, Fun between the parens
-@section Autodoc redux
+@node Documentation helpers, Evaluating Scheme code, The source and the REPL, Fun between the parens
+@section Documentation helpers
+
+@subsubheading Autodoc redux
The first thing you will notice by moving around Scheme source is that,
every now and then, the echo area lightens up with the same autodoc
@@ -258,18 +259,47 @@ instance, with @kbd{M-x customize-face}) to change the appearance of the
text. And another one (@var{geiser-font-lock-autodoc-current-arg}) that
controls how the current argument position is highlighted.
-@node Evaluating Scheme code, Jumping around, Autodoc redux, Fun between the parens
+@subsubheading Other documentation commands
+
+Sometimes, autodoc won't provide enough information for you to
+understand what a function does. In those cases, you can ask Geiser to
+ask the running Scheme for further information on a given identifier or
+module.
+
+For symbols, the incantation is @kbd{M-x geiser-doc-symbol-at-point}, or
+@kbd{C-c C-d C-d} for short. If the associated scheme supports
+docstrings (as, for instance, Guile does), you'll be teleported to a new
+Emacs buffer displaying Geiser's documentation browser, filled with
+information about the identifier, including its docstring (if any;
+unfortunately, that an implementation supports docstrings doesn't mean
+that they're used everywhere).
+
+@image{img/docstring}
+
+Pressing @kbd{q} in the documentation buffer will bring you back,
+enlightened, to where you were. There's also a handful of other
+navigation commands available in that buffer, which you can discover by
+means of its menu or via the good old @kbd{C-h m} command.
+
+For Racket, which does not support docstrings out of the box, this
+command will invoke Racket's @code{help} procedure, thereby opening your
+configured web browser with the corresponding manual page for you to
+peruse.
+
+You can also ask Geiser to display information about a module, in the
+form of a list of its exported identifiers, using @kbd{C-c C-d C-m},
+exactly as you would do @ref{repl-mod,,in the REPL}. This commands works
+with all supported Schemes, no strings attached.
+
+@node Evaluating Scheme code, Jumping around, Documentation helpers, Fun between the parens
@section Evaluating Scheme code
@node Jumping around, Geiser writes for you, Evaluating Scheme code, Fun between the parens
@section Jumping around
-@node Geiser writes for you, In good company, Jumping around, Fun between the parens
+@node Geiser writes for you, , Jumping around, Fun between the parens
@section Geiser writes for you
-@node In good company, , Geiser writes for you, Fun between the parens
-@section In good company
-
@c Local Variables:
@c mode: texinfo
@c TeX-master: "geiser"
diff --git a/doc/img/docstring.png b/doc/img/docstring.png
new file mode 100644
index 0000000..c0b018e
--- /dev/null
+++ b/doc/img/docstring.png
Binary files differ
diff --git a/doc/repl.texi b/doc/repl.texi
index 12231c7..8a73771 100644
--- a/doc/repl.texi
+++ b/doc/repl.texi
@@ -167,6 +167,7 @@ with its point resting upon the identifier's defining form. When you're
done inspecting, @kbd{M-,} will bring you back to where you were. As we
will see, these commands are also available in scheme buffers.
+@anchor{repl-mod}
Finally, Geiser can produce for you a list, classified by kind, of the
identifiers exported by a given module: all you need to do is press
@kbd{C-c C-d m}, and type or complete the desired module's name.