summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2011-01-10 16:01:23 +0100
committerJose Antonio Ortega Ruiz <jao@gnu.org>2011-01-10 16:01:23 +0100
commit8c4a672ccc24711edf61a0ef29747a870aba35f8 (patch)
treea4f9661c129a09b3af15df2410dab9cb3981e541
parentf9fbf7ee18f5de9b1608c303bb108552e041e205 (diff)
downloadgeiser-chez-8c4a672ccc24711edf61a0ef29747a870aba35f8.tar.gz
geiser-chez-8c4a672ccc24711edf61a0ef29747a870aba35f8.tar.bz2
More documentation improvements
-rw-r--r--doc/parens.texi27
-rw-r--r--doc/repl.texi12
2 files changed, 20 insertions, 19 deletions
diff --git a/doc/parens.texi b/doc/parens.texi
index 89b60a1..ff7f5fe 100644
--- a/doc/parens.texi
+++ b/doc/parens.texi
@@ -101,8 +101,8 @@ subsection}.
@subsubheading How Geiser associates a REPL to your Scheme buffer
@cindex scheme implementation, choosing
-To determine what Scheme implementation corresponds to a given source
-file, Geiser uses the following algorithm:
+@anchor{repl-association} To determine what Scheme implementation
+corresponds to a given source file, Geiser uses the following algorithm:
@enumerate
@item
@@ -140,7 +140,7 @@ ask you to explicitly choose the Scheme implementation.
@end enumerate
As you can see in the list above, there are several ways to influence
-Geiser's guessing by mean customizable variables. The most direct (and
+Geiser's guessing by means of customizable variables. The most direct (and
most impoverishing) is probably limiting the active implementations to a
single one, while customizing @code{geiser-implementations-alist} is the
most flexible (and, unsurprisingly, also the most complex). Here's the
@@ -200,7 +200,7 @@ really handy, if you ask me.
@cindex switching schemes
If for some reason you're not happy with the Scheme implementation that
Geiser has assigned to your file, you can change it with @kbd{C-c C-s},
-and probably take a look at @alt{@ref{switching-repl-buff,,the previous
+and probably take a look at @alt{@ref{repl-association,,the previous
subsection}, the previous subsection} to make sure that Geiser doesn't
get confused again.
@@ -223,7 +223,7 @@ can do for us, besides jumping to and fro.
@cindex autodoc, in scheme buffers
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
+every now and then, the echo area lights up with the same autodoc
messages we know and love from our REPL forays. This happens every
time the Scheme process is able to recognise an identifier in the
buffer, and provide information either on its value (for variables) or
@@ -239,7 +239,7 @@ in the echo area.
@cindex disabling autodoc
@cindex manual autodoc
Autodoc activation is controlled by a minor mode, @code{geiser-autodoc},
-which you can toggle with @kbd{M-x geiser-autodoc}, or its associated
+which you can toggle with @kbd{M-x geiser-autodoc-mode}, or its associated
keyboard shortcut, @kbd{C-c C-d a}. That @t{/A} indicator in the
mode-line is telling you that autodoc is active. If you prefer that it
be inactive by default (e.g., because you're connecting to a really
@@ -256,7 +256,7 @@ identifier at hand is defined, followed by a colon and the identifier
itself. If the latter corresponds to a procedure or macro, it will be
followed by a list of argument names, starting with the ones that are
required. Then there comes a list of optional arguments, if any,
-enclosed in parenthesis. When an optional argument has a default value
+enclosed in parentheses. When an optional argument has a default value
(or a form defining its default value), autodoc will display it after
the argument name. When the optional arguments are keywords, their names
are prefixed with ``#:'' (i.e., their names @i{are} keywords). An
@@ -275,14 +275,14 @@ In those cases, autodoc shows all known signatures (using the above
rules for each one) separated by a vertical bar (|).
As you have already noticed, the whole autodoc message is enclosed in
-parenthesis. After all, we're talking about Scheme here.
+parentheses. After all, we're talking about Scheme here.
@cindex autodoc for variables
@img{autodoc-var, right} Finally, life is much easier when your cursor
is on a symbol corresponding to a plain variable: you'll see in the echo
area its name, preceded by the module where it's defined, and followed
by its value, with an intervening arrow for greater effect. This time,
-there are no enclosing parenthesis (i hope you see the logic in my
+there are no enclosing parentheses (i hope you see the logic in my
madness).
@cindex autodoc customized
@@ -403,11 +403,11 @@ definition containing point and sends it for evaluation. The variant
way, but it also teleports you to REPL after the evaluation.
@code{geiser-eval-region}, bound to @kbd{C-c C-r}, evals the current
-region. Again, there's an @i{and go} version available,
+region. Again, there's an @i{and-go} version available,
@code{geiser-eval-region-and-go}, bound to @kbd{C-c M-r}.
For all the commands above, the result of the evaluation is displayed in
-the minibuffer, unless it causes a (scheme-side) error (@pxref{To err
+the minibuffer, unless it causes a (Scheme-side) error (@pxref{To err
perchance to debug}).
At the risk of repeating myself, i'll remind you that all these
@@ -472,7 +472,7 @@ thing for racketeers and @i{geiser-racket}.
@section Jumping around
@cindex jumping in scheme buffers
-This one feature is as sweet as easy to explain: @kbd{M-.}
+This one feature is as sweet as it is easy to explain: @kbd{M-.}
(@code{geiser-edit-symbol-at-point}) will open the file where the
identifier around point is defined and land your point on its
definition. To return to where you were, press @kbd{M-,}
@@ -485,7 +485,8 @@ Sometimes, the underlying Scheme will tell Geiser only the file where
the symbol is defined, but Geiser will use some heuristics (read,
regular expressions) to locate the exact line and bring you there. Thus,
if you find Geiser systematically missing your definitions, send a
-message to the mailing list and we'll try to make the algorithm smarter.
+message to the @email{geiser-users@@nongnu.org, mailing list}, and we'll
+try to make the algorithm smarter.
@cindex jumping customized
You can control how the destination buffer pops up by setting
diff --git a/doc/repl.texi b/doc/repl.texi
index bded2b7..3b35e49 100644
--- a/doc/repl.texi
+++ b/doc/repl.texi
@@ -173,7 +173,7 @@ Which brings me to the next group of REPL commands.
@cindex completion, at the REPL
We've already seen Geiser completion of module names in action at the
-mini-buffer. You won't be surprised to know that it's also available at
+minibuffer. You won't be surprised to know that it's also available at
the REPL buffer itself. There, you can use either @kbd{C-.} or
@kbd{M-`} to complete module names, and @kbd{@key{TAB}} or
@kbd{M-@key{TAB}} to complete identifiers. Geiser will know what
@@ -188,7 +188,7 @@ the Scheme interpreter, and you can use the @command{next-error} command
(@kbd{M-g n}) to jump to their location. By default, every time you
enter a new expression for evaluation old error messages are forgotten,
so that @kbd{M-g n} will always jump to errors related to the last
-evaluation request, if any. If you prefer a not so forgetful REPL, set
+evaluation request, if any. If you prefer a not-so-forgetful REPL, set
the customization variable @code{geiser-repl-forget-old-errors-p} to
@code{nil}. Note, however, that even when that variable is left as
@kbd{t}, you can always jump to an old error by moving to its line at
@@ -200,18 +200,18 @@ use @kbd{BACKTAB} everywhere to go to the previous one.
@section Autodoc and friends
Oftentimes, there's more you'll want to know about an identifier
-besides its name: what module does it belong to? is it a procedure and,
+besides its name: What module does it belong to? Is it a procedure and,
if so, what arguments does it take? Geiser tries to help you answering
those questions too.
@cindex autodoc, in the REPL
Actually, if you've been playing with the REPL as you read, you might
-have notice some frantic activity taking place in the minibuffer every
+have notice some frantic activity taking place in the echo area every
now and then. That was Geiser trying to be helpful (while, hopefully,
not being clippy), or, more concretely, what i call, for want of a
better name, its @dfn{autodoc} mode. Whenever it's active (did you
notice that @i{A} in the mode-line?), Geiser's gerbils will be scanning
-what you type and showing (unless you silent them with @kbd{C-c C-d C-a})
+what you type and showing (unless you silence them with @kbd{C-c C-d C-a})
information about the identifier nearest to point.
@imgc{repl-autodoc}
@@ -221,7 +221,7 @@ namespace, you'll see the module it belongs to and its value. For
procedures and macros, autodoc will display, instead of their value, the
argument names (or an underscore if Geiser cannot determine the name
used in the definition). Optional arguments are surrounded by
-parenthesis. When the optional argument has a default value, it's
+parentheses. When the optional argument has a default value, it's
represented by a list made up of its name and that value. When the
argument is a keyword argument, its name has ``#:'' as a prefix.