summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2010-12-11 04:05:57 +0100
committerJose Antonio Ortega Ruiz <jao@gnu.org>2010-12-11 04:05:57 +0100
commitdfe2b83ff6eb51cbaf134b5cdfc1e416c1541b8b (patch)
treec6d4321d432fbf3c63476f926d2d69c2f7384291
parent4a156187b4918e934c30ea2403d8dcb57cfcc720 (diff)
downloadgeiser-guile-dfe2b83ff6eb51cbaf134b5cdfc1e416c1541b8b.tar.gz
geiser-guile-dfe2b83ff6eb51cbaf134b5cdfc1e416c1541b8b.tar.bz2
Documentation updates, and a shiny new image
-rw-r--r--doc/img/docstring-racket.pngbin0 -> 12733 bytes
-rw-r--r--doc/img/docstring.pngbin16390 -> 16361 bytes
-rw-r--r--doc/parens.texi11
3 files changed, 8 insertions, 3 deletions
diff --git a/doc/img/docstring-racket.png b/doc/img/docstring-racket.png
new file mode 100644
index 0000000..410614d
--- /dev/null
+++ b/doc/img/docstring-racket.png
Binary files differ
diff --git a/doc/img/docstring.png b/doc/img/docstring.png
index c0b018e..476fb05 100644
--- a/doc/img/docstring.png
+++ b/doc/img/docstring.png
Binary files differ
diff --git a/doc/parens.texi b/doc/parens.texi
index c65522b..6bd5e5f 100644
--- a/doc/parens.texi
+++ b/doc/parens.texi
@@ -298,11 +298,16 @@ that they're used everywhere).
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.
+means of its menu or via the good old @kbd{C-h m} command. And feel free
+to use the navigation buttons and hyperlinks that justify my calling
+this buffer a documentation browser.
For Racket, which does not support docstrings out of the box, this
command will provide less information, but the documentation browser
-will display the corresponding contract when it's available.
+will display the corresponding contract when it's available, as well as
+some other tidbits for re-exported identifiers.
+
+@imgc{docstring-racket}
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},
@@ -322,7 +327,7 @@ You can also jump directly to the manual page for the symbol at point
with the command @code{geiser-doc-look-up-manual}, bound to @kbd{C-c C-d
i}.
-See also our @xref{Documentation browser,,cheat-sheet} for a list of
+See also our @ref{Documentation browser,,cheat-sheet} for a list of
navigation commands available in the documentation browser.
@node To eval or not to eval, To err perchance to debug, Documentation helpers, Between the parens