unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Radon Rosborough <radon.neon@gmail.com>
To: 28781@debbugs.gnu.org
Subject: bug#28781: 25.3; Override erroneous "incorrect verb voice" from checkdoc
Date: Tue, 10 Oct 2017 10:52:18 -0700	[thread overview]
Message-ID: <CADB4rJHWb8rht8Ds6N4GeXLeRy55+MA7b0Fv_yW4ebwBVS8H5A@mail.gmail.com> (raw)

I have the following definition:

    (defmacro straight--functionp (object)
      "Non-nil if OBJECT, an unquoted symbol, evaluates to a function.
    However, if OBJECT evaluates to its own symbol value or t, then
    return nil. This is useful for allowing a function to be called
    with nil, non-nil, or a function object, without worrying about
    the non-nil value being interpreted as a function: just call the
    function with the quoted name of the argument, or use t."
      (let ((object-sym (make-symbol "object")))
        `(let ((,object-sym ,object))
           (and (not (memq ,object-sym '(,object t)))
                (functionp ,object-sym)))))

M-x checkdoc reports the following on the first line:

    Probably "evaluates" should be imperative "evaluate"

This is wrong. How can I suppress this spurious warning, other than by
rewording the docstring? I know that checkdoc has
`checkdoc-symbol-words' for suppressing spurious warnings about unquoted
symbols, but there appears to be nothing similar I can customize in
file-local variables for this case.





             reply	other threads:[~2017-10-10 17:52 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-10 17:52 Radon Rosborough [this message]
2017-10-10 19:24 ` bug#28781: 25.3; Override erroneous "incorrect verb voice" from checkdoc Eli Zaretskii
2017-10-10 19:44   ` Radon Rosborough
2017-10-10 20:05     ` Eli Zaretskii
2017-10-10 20:31       ` Radon Rosborough
2017-10-11 13:09         ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CADB4rJHWb8rht8Ds6N4GeXLeRy55+MA7b0Fv_yW4ebwBVS8H5A@mail.gmail.com \
    --to=radon.neon@gmail.com \
    --cc=28781@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).