Re: Spell checking of the commentary section by checkdoc.el.

[Stefan Monnier]

> >> That seems like a reasonable change to me.  It may accidentally
> >> pick up todo lists, and other miscellany comments too, but they may
> >> need spell checking too.
> >
> > Shouldn't we use lisp-mnt.el functionality instead ?
> > (or add/fix it if it's missing/broken)
> 
> Currently, lisp-mnt.el has the functions lm-commentary-mark, which
> returns the beginning of the commentary section, and lm-commentary,
> which returns the comment section as a string.  checkdoc.el cannot use
> the latter function as it uses ispell for spell checking and, as I
> understand it, ispell only works on buffers.  So checkdoc.el
> additionally needs the end of the commentary section (as a buffer
> position).  We could introduce lm-commentary-end for this purpose and
> let lm-commentary use it (as well).  The way lm-commentary now
> determines the end of the commentary section is not very robust,
> though.  It depends on the presence of a ChangeLog/History or Code
> header.  Maybe we should let lm-commentary-end fall back to my method
> of finding the end of the commentary section (i.e., skipping over all
> whitespace and comment lines) in case the aforementioned headers are
> absent?

We should probably introduce a lm-section-start and lm-section-end,
where the end of a section is defined as "just before the beginning
of the next section".

It's a bug for the `commentary' section not to be followed by some
other section (typically `code', sometimes `history' or `todo' or `bugs').


        Stefan


PS: By the way, I think we should introduce a new section whose
    content is Texinfo prefixed with `;; ', and we should then
    automatically build an "Emacs Packages Manuals" info page
    (separate from the emacs manual) that holds the doc of all
    those packages.