Typos in the manual

[Ralf Wildenhues]

Hello Guile developers,

I found a few typos in the manual, actually, comparatively very few for
the size of the manual!  The attached patches should fix them.  Please
be scrupulous, I'm not firm in Guile language details nor habits.

Note the first one may be mangled by email transport, which is why I
gziped it; it removes a non-ASCII character from the text.  It should be
possible to skip it if needed and use 'git am -3' on the rest.


There are a few things that I spotted that I didn't fix, either because
I didn't know which was the right way, or in cases that I've come to
know as contentious among developers.  It would be nice if you could go
over them and address them in one way or another.  Given consensus, I
might be prodded into patching some, but don't count on me.

- Word pairs you might want to review and/or maybe just use one set of:
    queuing vs. queueing,
    destructur.* vs. destruct.* vs. deconstr.*
    (unless they have different meanings of course),
    uninterned vs. non-internal,
    latin1 vs. latin-1,
    parsable vs. parseable.

- 'postpend': I'd replace this with 'append' throughout the tree
  (not just the manual).

- Some abbreviations are spelt creatively.  The Latin 'id est' is
  usually abbreviated 'i.e.' without an intervening space, and for good
  spacing you either need a comma right afterwards, or '@:'.  Same with
  'e.g.'.  Find lots of instances with:
    git grep '\<[Ii][. ]*e\.[^,@]'

  My personal preference is to use a comma when what follows is long or
  grammatically a full sentence, and '@:' otherwise.  (info texinfo "Not
  Ending a Sentence").

- The Guile manual seems quite eager in making up new words.  This is to
  some extent a tendency that just comes with hacking, and has both
  distinguished and entertaining aspects.  At the same time however, it
  can make things less accessible for new users, especially those with a
  foreign native language, who then have troubles looking such words up
  in some dictionary.  It starts with very simple things like 'dir' and
  'arg' which I assume nobody has a serious problem with, yet which I
  would always write as 'directory' and 'argument' in prose
  (cf. 'info standards "GNU Manuals"'; but this goes beyond that text).
  OTOH, things like 'unpermanent', 'cdring', and 'consing' are not easy
  to understand IMVHO.

- In the Autoconf section, several macros are added to the function
  index.  They come from doc/ref/autoconf{,-macros}.texi (one being
  generated from meta/guile.m4.  The macros are:
    PKG_CHECK_MODULES
    GUILE_PROGS
    GUILE_FLAGS
    GUILE_SITE_DIR
    GUILE_CHECK_RETVAL
    GUILE_MODULE_CHECK
    GUILE_MODULE_AVAILABLE
    GUILE_MODULE_REQUIRED
    GUILE_MODULE_EXPORTS
    GUILE_MODULE_REQUIRED_EXPORT

  The simplest way to fix this would be to adjust indices.texi to
  document that Autoconf macros and variables are also listed in this
  index.  Karl tells me that one should have less indices anyway for the
  autotools manuals (ideally just one), so this would seem like a step
  in the right direction.

- I love France and the Franc, but there will soon be kids that don't
  remember it, for which 'french currency string' will be a foreign
  concept.  It might be a good idea to update the example eventually.

Thanks for maintaining Guile,
Ralf

0001-docs-remove-non-ASCII-space-from-docs.patch.gz
Description: application/gunzip

0002-docs-fix-typos-in-manual-and-a-couple-in-code-commen.patch
Description: Text document

0003-fix-typos-in-the-manual-bits-generated-from-source-c.patch
Description: Text document

0004-docs-fix-markup-in-api-options.texi.patch
Description: Text document

0005-docs-add-missing-parentheses-in-asin-formula.patch
Description: Text document