Subject: Re: [bug#44089] [PATCH] gnu: Add emacs-wucuo.

From: Nicolas Goaziou <[email-masked]>
Date: Tue, 20 Oct 2020 12:11:38 +0200

Hello,

Joseph LaFreniere <[email-masked]> writes:

> Subject: [PATCH] gnu: Add emacs-wucuo.
>
> * gnu/packages/emacs-xyz.scm (emacs-wucuo): New variable.

Thank you. Some comments follow.

> +    (version "0.2.7")

Based on your feedback, upstream released 0.2.8 a few hours ago.

> +       (sha256
> +        (base32
> +         "1iw4jdlqvki95gh7bzl7hjidc2kz9qyc1zjd7klh63gvk0z09700"))))

Nitpick: please move the string on the same line as `base32'.

> +    (build-system emacs-build-system)
> +    (home-page "https://github.com/redguardtoo/wucuo")
> +    (synopsis
> +     "Fastest solution to spell check camel case code or plain text")

Please move the string on the same line as `synopsis'. Also, "fastest"
sounds like a buzzword. I think "Fast" would be more neutral.

> +    (description
> +     "This package provides a spell checker on top of either aspell or
> +hunspell.
> +
> +@itemize
> +@item @code{wucuo-spell-check-file} will spell check one file and report its
> +typos
> +@item If @code{wucuo-flyspell-start-mode} is \"normal\", @code{wucuo-start}
> +runs @code{flyspell-buffer}.  If it's \"normal\", @code{wucuo-start} runs
> +@code{flyspell-region} to check visible region in current window.
> +@item The interval of checking is set by @code{wucuo-update-interval}
> +@end itemize
> +
> +See @code{wucuo-check-nil-font-face} on how to check plain text (text without
> +font)
> +@itemize
> +@item Use @code{wucuo-current-font-face} to detect font face at point
> +@item If @code{wucuo-flyspell-start-mode} is \"normal\",
> +@code{wucuo-spell-check-buffer-max} specifies the maximum size of buffer to
> +check.  If @code{wucuo-flyspell-start-mode} is \"fast\",
> +@code{wucuo-spell-check-region-max} specifies the maximum size of visible
> +region to check.
> +@item You can define a function in @code{wucuo-spell-check-buffer-predicate}.
> +If the function returns t, the spell checking of current buffer will continue.
> +If it returns nil, the spell checking is skipped.
> +@end itemize
> +
> +Here is sample to skip checking in specified major modes,
> +@lisp
> + (setq wucuo-spell-check-buffer-predicate
> +        (lambda ()
> +          (not (memq major-mode
> +                     '(dired-mode
> +                       log-edit-mode
> +                       compilation-mode
> +                       help-mode
> +                       profiler-report-mode
> +                       speedbar-mode
> +                       gud-mode
> +                       calc-mode
> +                       Info-mode)))))
> +@end lisp")

I think most of this belongs to the manual, not to the description. What
about:

  This package provides a spell checker on top of either Aspell or
  Hunspell, and relies on Flyspell internally.  It operates on the
  current region or buffer, a file, or a complete directory.

Could you send an updated patch?

Regards,
-- 
Nicolas Goaziou