From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#28781: 25.3; Override erroneous "incorrect verb voice" from checkdoc Date: Tue, 10 Oct 2017 23:05:15 +0300 Message-ID: <83a80ypy4k.fsf@gnu.org> References: <83infmq010.fsf@gnu.org> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: blaine.gmane.org 1507665984 20411 195.159.176.226 (10 Oct 2017 20:06:24 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 10 Oct 2017 20:06:24 +0000 (UTC) Cc: 28781@debbugs.gnu.org To: Radon Rosborough Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Oct 10 22:06:17 2017 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e20my-0003ML-Hl for geb-bug-gnu-emacs@m.gmane.org; Tue, 10 Oct 2017 22:06:04 +0200 Original-Received: from localhost ([::1]:36948 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e20n6-00038X-0D for geb-bug-gnu-emacs@m.gmane.org; Tue, 10 Oct 2017 16:06:12 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:44098) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e20mz-00038R-VE for bug-gnu-emacs@gnu.org; Tue, 10 Oct 2017 16:06:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1e20mw-00060U-P2 for bug-gnu-emacs@gnu.org; Tue, 10 Oct 2017 16:06:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:52282) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1e20mw-0005zz-Ku for bug-gnu-emacs@gnu.org; Tue, 10 Oct 2017 16:06:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1e20mw-0007BA-Am for bug-gnu-emacs@gnu.org; Tue, 10 Oct 2017 16:06:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 10 Oct 2017 20:06:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 28781 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 28781-submit@debbugs.gnu.org id=B28781.150766595027509 (code B ref 28781); Tue, 10 Oct 2017 20:06:02 +0000 Original-Received: (at 28781) by debbugs.gnu.org; 10 Oct 2017 20:05:50 +0000 Original-Received: from localhost ([127.0.0.1]:60963 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e20mk-00079c-1C for submit@debbugs.gnu.org; Tue, 10 Oct 2017 16:05:50 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:52976) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e20mi-00079P-B2 for 28781@debbugs.gnu.org; Tue, 10 Oct 2017 16:05:48 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1e20mZ-0005gZ-Jb for 28781@debbugs.gnu.org; Tue, 10 Oct 2017 16:05:42 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:33603) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e20mZ-0005gV-GJ; Tue, 10 Oct 2017 16:05:39 -0400 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:2698 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1e20mX-0006M8-KN; Tue, 10 Oct 2017 16:05:39 -0400 In-reply-to: (message from Radon Rosborough on Tue, 10 Oct 2017 12:44:05 -0700) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:138196 Archived-At: > From: Radon Rosborough > Date: Tue, 10 Oct 2017 12:44:05 -0700 > Cc: 28781@debbugs.gnu.org > > Is it recommended to have all function docstrings start with a verb? Yes. From the ELisp manual, node "Documentation Tips" For a function, the first line should briefly answer the question, “What does this function do?” For a variable, the first line should briefly answer the question, “What does this value mean?” (It talks about the first line of the doc string.) > If so, maybe the docstring for `functionp' should be changed (after > all, it was what I modeled this one off of): > > Non-nil if OBJECT is a function. Yes, I think so.