From 3016223d92f17667a44f001930fb6ffa42419eb8 Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Sat, 11 Dec 2010 04:05:57 +0100 Subject: Documentation updates, and a shiny new image --- doc/img/docstring-racket.png | Bin 0 -> 12733 bytes doc/img/docstring.png | Bin 16390 -> 16361 bytes doc/parens.texi | 11 ++++++++--- 3 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 doc/img/docstring-racket.png diff --git a/doc/img/docstring-racket.png b/doc/img/docstring-racket.png new file mode 100644 index 0000000..410614d Binary files /dev/null and b/doc/img/docstring-racket.png differ diff --git a/doc/img/docstring.png b/doc/img/docstring.png index c0b018e..476fb05 100644 Binary files a/doc/img/docstring.png and b/doc/img/docstring.png 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 -- cgit v1.2.3