From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#17566: 24.4.50; describe parameters in doc string: `dired-move-to-filename' etc. Date: Mon, 07 Oct 2019 19:44:44 +0200 Message-ID: <87k19g30xf.fsf@gnus.org> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="80186"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux) Cc: 17566@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Oct 07 19:45:21 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iHX4S-000Kl5-Ox for geb-bug-gnu-emacs@m.gmane.org; Mon, 07 Oct 2019 19:45:20 +0200 Original-Received: from localhost ([::1]:48264 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iHX4R-0007jA-IA for geb-bug-gnu-emacs@m.gmane.org; Mon, 07 Oct 2019 13:45:19 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:43364) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iHX4F-0007iu-Im for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:45:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iHX4D-0005nI-F0 for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:45:07 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:40237) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iHX4A-0005kM-Ew for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:45:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iHX4A-0002iY-C0 for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:45:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 07 Oct 2019 17:45:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 17566 X-GNU-PR-Package: emacs Original-Received: via spool by 17566-submit@debbugs.gnu.org id=B17566.157047028910398 (code B ref 17566); Mon, 07 Oct 2019 17:45:02 +0000 Original-Received: (at 17566) by debbugs.gnu.org; 7 Oct 2019 17:44:49 +0000 Original-Received: from localhost ([127.0.0.1]:49055 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iHX3x-0002he-IT for submit@debbugs.gnu.org; Mon, 07 Oct 2019 13:44:49 -0400 Original-Received: from quimby.gnus.org ([80.91.231.51]:42818) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iHX3v-0002hU-Vt for 17566@debbugs.gnu.org; Mon, 07 Oct 2019 13:44:48 -0400 Original-Received: from cm-84.212.202.86.getinternet.no ([84.212.202.86] helo=marnie) by quimby.gnus.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iHX3s-0006X1-Ns; Mon, 07 Oct 2019 19:44:47 +0200 In-Reply-To: (Drew Adams's message of "Fri, 23 May 2014 11:39:01 -0700 (PDT)") 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: 209.51.188.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:168564 Archived-At: Drew Adams writes: > Subject line says it all. Parameters should be described in doc > strings! In the case of `dired-move-to-filename' it is not at all > obvious what parameter RAISE-ERROR means, for example. Even the code > comments seem to have trouble describing what RAISE-ERROR is for. I've now documented the parameters to that function in Emacs 27. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no