From 632a069eed54f3912c799b5497ece78d4e8a42d0 Mon Sep 17 00:00:00 2001 From: Jose Antonio Ortega Ruiz Date: Tue, 23 Nov 2010 01:58:33 +0100 Subject: Document browser improvements, and Racket using them We have a new "manual lookup" command, and Racket now displays a doc browser buffer for help with a button activating it. In the process, we've cleaned-up a little mess in geiser-eval.el and geiser-doc.el, and refactored the affected Racket modules. Next in line is providing manual lookup for Guile. --- doc/parens.texi | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) (limited to 'doc/parens.texi') diff --git a/doc/parens.texi b/doc/parens.texi index 439e56c..c4aa228 100644 --- a/doc/parens.texi +++ b/doc/parens.texi @@ -278,10 +278,10 @@ controls how the current argument position is highlighted. @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. +@anchor{doc-browser}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. @cindex documentation for symbol @cindex docstrings, maybe @@ -301,14 +301,29 @@ 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. +command will provide less information, but the documentation browser +will display the corresponding contract when it's available. 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. +exactly as you would do @ref{repl-mod,,in the REPL}. + +In both cases, the documentation browser will show a couple of buttons +giving you access to further documentation. First, you'll see a button +named @i{source}: pressing it you'll jump to the symbol's definition. +The second button, dubbed @i{manual}, will open the scheme +implementation's manual page for the symbol at hand. For Racket, that +will open your web browser displaying the corresponding reference's page +(using Emacs' @code{browser-url} command), while in Guile a lookup will +be performed in the texinfo manual. + +@cindex opening manual pages +You can also jump directly to the manual page for the symbol at point +with the command @code{geiser-doc-lookup-manual}, bound to @kbd{C-c C-d +i}. + +See also our @xref{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 @section To eval or not to eval -- cgit v1.2.3