Re: [PATCH] Flymake Support Indicator Errors in Margin

[Eli Zaretskii <eliz@gnu.org>]

> From: Elijah G <eg642616@gmail.com>
> Date: Sat, 6 Apr 2024 14:14:34 -0600
> Cc: sbaugh@catern.com, sbaugh@janestreet.com, philipk@posteo.net, 
> 	emacs-devel@gnu.org, luangruo@yahoo.com
> 
> > Last, but not least: please mention this change (and the new user
> > options) in NEWS and in the Flymake manual.
> 
> Thank you, I've now fixed the patch and documented the changes done.

See below for some additional comments.

> Also I have a question, Do I need to assign copyright each time
> that I want to contribute to Flymake?

No, you assign the copyright for past and future changes, and you do
it only once.

Did you start the paperwork already?  I don't see your assignment on
file, so if you haven't started the paperwork, now is the time to do
it.  Let me know if you need me to send you the form to fill and the
instructions, to start the paperwork.

> I have a lot of ideas that I would like to contribute.

Thanks, looking forward to your contributions.

> --- a/doc/misc/flymake.texi
> +++ b/doc/misc/flymake.texi
> @@ -309,6 +309,11 @@ Customizable variables
>  A custom face for highlighting regions for which a note has been
>  reported.
>  
> +@item flymake-indicator-type
> +Which indicator type should Flymake use.

Suggest to reword:

  The indicator type which Flymake should use to indicate lines with
  errors or warnings.

> +@item flymake-margin-indicators-string
> +A List used for specify string, face and error types to
> +use in the margin indicators.

Suggest to reword:

  Specifies the string and face to use for the margin indicators, for
  each error type.

> +@item flymake-autoresize-margins
> +If non-@code{nil}, will resize margins either @code{flymake-mode} is
> +non-@code{nil} or @code{nil}.

Something is wrong with this sentence.  You probably mean

   If non-@code{nil}, Flymake will resize the margins when
   @code{flymake-mode} is turned on or off.

> +@item
> +@cindex margin of diagnostic
> +@code{flymake-margin-string}, an string displayed in the margin
                                 ^^^^^^^^^
"a string"

> +The value actually follows the syntax of @code{flymake-margin-indicators-string}
> +(@pxref{Customizable variables}). It is overridden by any
                                   ^^
Two spaces between sentences, please.

> ++++
> +*** New user option 'flymake-indicator-type'.
> +This user option controls which error indicator type Flymake should use
> +in current buffer. Depending on your preference, this can either use
                    ^^
Likewise.

> +*** New user option 'flymake-margin-indicators-string'

All heading lines in NEWS should end in a period.

> +It controls the string, their face and type error to display in
> +margin indicators.

  It controls, for each error type, the string and its face to display
  as the margin indicator.

> +*** New user option 'flymake-autoresize-margins'

Missing period at the end.

> +When non-nil, Flymake will resize margins either `flymake-mode` is
> +non-nil or nil.

See above for correction in the manual, I think the same wording
should be used here.

Also, please quote 'like this', not `like this` (here and elsewhere in
the patch for NEWS).

> +*** New user option 'flymake-margin-indicator-position'

Period missing at the end.

> +It controls which position should Flymake show margin indicators.

  It controls which margin (left or right) is used for margin
  indicators.

> +(defvar-local flymake--original-margin-width nil
> +  "Store original margin width.
> +Used by `flymake--resize-margins' for restore original margin width
                                     ^^^^^^^^^^^
"for restoring"