geiser-users
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Geiser-users] Corrections for Geiser/doc/parens.texi


From: Mark Harig
Subject: [Geiser-users] Corrections for Geiser/doc/parens.texi
Date: Mon, 10 Jan 2011 01:58:38 -0500

Here are some possible improvements I noticed for
parens.texi.  In each case, I have preceded the texinfo
text with the tag '--- Texinfo source' and followed it
with a description of the change.  These aren't always
errors, so I'm sending a description instead of a patch.

--- Texinfo source:

Geiser's support for writing Scheme code adds to Emacs'
@code{scheme-mode}, rather than supplanting it; and it does so by means
of a minor mode (unimaginatively dubbed @code{geiser-mode}) that defines
a bunch of new commands to try and, with the help of the same Scheme
process giving you the REPL, make those Scheme buffers come to life.

Suggestion:

Do not "try AND make."  Instead, "try TO make," that is, "...defines a
bunch of new commands to try to...make..."  Or, delete the words "try
and" so that the statement is "...defines a bunch of new commands to
make, with the help..., those Scheme buffers..."


--- Texinfo source:

As you can see in the list above, there are several ways to influence
Geiser's guessing by mean customizable variables.

Correction:

"...by mean customizable..." should be "...by means of
customizable..."


--- Texinfo source:

@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 @address@hidden,,the previous
subsection}, the previous subsection} to make sure that Geiser doesn't
get confused again.

Correction:

1) The anchor that this paragraph's reference refers to appears to be
  the same section that the reader has just read, that is,
  `switching-repl-buff'.  Another anchor is needed near the beginning
  of the subsubheading "How Geiser associates a REPL...," so that the
  cross-reference can refer to it instead, correct?

2) The clause that began with "...and probably take a look..." does
  not have a subject: "...and you should probably take a look..."


--- Texinfo source:

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
messages we know and love from our REPL forays.

Correction:

"lightens" is the opposite of "darkens," correct?  Is "...the echo
area lights up..." intended?


--- Texinfo source:

@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
keyboard shortcut, @kbd{C-c C-d a}.

Correction:

The command `geiser-autodoc' should be `geiser-autodoc-mode'.


--- Texinfo source:

Then there comes a list of optional arguments, if any, enclosed in
parenthesis.

and,

As you have already noticed, the whole autodoc message is enclosed in
parenthesis.

and,

This time, there are no enclosing parenthesis (i hope you see the
logic in my madness).

Correction:

"parenthesis" should be the plural "parentheses" in each of these
three statements, above.


--- Texinfo source:

Again, there's an @i{and go} version available,
@code{geiser-eval-region-and-go}, bound to @kbd{C-c M-r}.

Suggestion:

Make "and go" a hyphenated modifier, especially since Info doesn't
provide italicized text, that is, "...an and-go version..."


--- Texinfo source:

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
perchance to debug}).

Capitalization: Change (scheme-side) to (Scheme-side).


--- Texinfo source:

This one feature is as sweet as 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.

Correction:

Change "This one feature is as sweet as easy..." to "This one feature
is as sweet as it is easy..."


--- Texinfo source:

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.

Suggestion:

Add the @email macro to this sentence, for example,

Thus, if you find Geiser systematically missing your definitions, send
a message to the @email{geiser-users@@nongnu.org, mailing list}, and
we'll try to make the algorithm smarter.

(See the node "(texinfo) email" for a description of this macro.)

---



reply via email to

[Prev in Thread] Current Thread [Next in Thread]