Re: feature request: public API to get new flymake's errors/warnings

[Eli Zaretskii <eliz@gnu.org>]

> From: joaotavora@gmail.com (João Távora)
> Date: Thu, 19 Oct 2017 12:36:05 +0100
> Cc: emacs-devel@gnu.org
> 
> The attached patch augments the API for these purposes (and describes it
> in the manual).

A few comments to the documentation:

> -Since overlays also support arbitrary keymaps, you can use this
> -property @code{flymake-text} to create interactive annotations, such
> -as in the following example of binding a @kbd{mouse-3} event (middle
> -mouse button click) to an Internet search for the text of a
> -@code{:warning} or @code{:error}.
> +Since overlays also support arbitrary keymaps, you can this along with
                                                  ^^^^^^^^^^^^
The "use" part is missing.

> +the functions @code{flymake-diagnostics} and
> +@code{flymake-diagnostic-text} (@pxref{Flymake utility functions}) to
> +create interactive annotations, such as in the following example of
> +binding a @kbd{mouse-3} event (middle mouse button click) to an
             ^^^^^^^^^^^^^
Since you are talking about an event, not something that the user
does, @code is a better markup here.

> +@deffn Function flymake-diagnostics beg end
> +Get a list of Flymake diagnostics in the region comprised between
> +@var{beg} and @var{end}.  If neither @var{beg} or @var{end} is

I'd say "in the region determined by @var{beg} and @var{end}".  I
think it's both more correct English and avoids misinterpretation of
what exactly "between" means (is in exclusive or inclusive?).

> +supplied, use the whole buffer, otherwise if @var{beg} is non-nil and
> +@var{end} is nil, consider only diagnostics at @var{beg}.

"nil" should have the @code markup (2 counts).

> +(defun flymake-diagnostics (&optional beg end)
> +  "Get Flymake diagnostics in region comprised between BEG and END.

Same comment here about the "comprised between" part.

Thanks.