From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#19421: 25.0.50; doc string of `browse-url' must describe parameter ARGS Date: Sat, 26 Dec 2015 20:53:39 +0200 Message-ID: <8337uphwi4.fsf@gnu.org> References: < <87mvsywduo.fsf@gnus.org>> <<8db0a3c8-08b4-40c3-93a8-23ec9fcd8174@default>> <<83bn9dk208.fsf@gnu.org>> <41cee0e8-d5b7-4b6d-8f5b-314c01142f3a@default> Reply-To: Eli Zaretskii NNTP-Posting-Host: plane.gmane.org X-Trace: ger.gmane.org 1451156065 7042 80.91.229.3 (26 Dec 2015 18:54:25 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 26 Dec 2015 18:54:25 +0000 (UTC) Cc: larsi@gnus.org, 19421@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Dec 26 19:54:14 2015 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1aCtyn-00087c-87 for geb-bug-gnu-emacs@m.gmane.org; Sat, 26 Dec 2015 19:54:13 +0100 Original-Received: from localhost ([::1]:39587 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aCtym-0005uK-Js for geb-bug-gnu-emacs@m.gmane.org; Sat, 26 Dec 2015 13:54:12 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:45078) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aCtyg-0005u1-GO for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2015 13:54:10 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aCtyc-0002gw-PD for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2015 13:54:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:34502) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aCtyc-0002gs-LF for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2015 13:54:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84) (envelope-from ) id 1aCtyc-0001zD-Cv for bug-gnu-emacs@gnu.org; Sat, 26 Dec 2015 13:54:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 26 Dec 2015 18:54:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 19421 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 19421-submit@debbugs.gnu.org id=B19421.14511559927580 (code B ref 19421); Sat, 26 Dec 2015 18:54:02 +0000 Original-Received: (at 19421) by debbugs.gnu.org; 26 Dec 2015 18:53:12 +0000 Original-Received: from localhost ([127.0.0.1]:42104 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84) (envelope-from ) id 1aCtxk-0001y9-Mx for submit@debbugs.gnu.org; Sat, 26 Dec 2015 13:53:12 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:53687) by debbugs.gnu.org with esmtp (Exim 4.84) (envelope-from ) id 1aCtxg-0001xW-AQ for 19421@debbugs.gnu.org; Sat, 26 Dec 2015 13:53:07 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aCtxX-0002SR-9M for 19421@debbugs.gnu.org; Sat, 26 Dec 2015 13:52:58 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:55190) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aCtxX-0002SN-62; Sat, 26 Dec 2015 13:52:55 -0500 Original-Received: from 84.94.185.246.cable.012.net.il ([84.94.185.246]:1654 helo=HOME-C4E4A596F7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1aCtxW-00057X-Ds; Sat, 26 Dec 2015 13:52:54 -0500 In-reply-to: <41cee0e8-d5b7-4b6d-8f5b-314c01142f3a@default> (message from Drew Adams on Sat, 26 Dec 2015 08:40:36 -0800 (PST)) 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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:110730 Archived-At: > Date: Sat, 26 Dec 2015 08:40:36 -0800 (PST) > From: Drew Adams > Cc: larsi@gnus.org, 19421@debbugs.gnu.org > > > If you looked at the > > functions that can be invoked by browse-url, you know that they either > > ignore ARGS or (in a few cases) use ARGS to pass the NEW-WINDOW flag, > > in which case the corresponding function documents that. > > If a given function that has an ARGS &rest parameter does nothing > else with ARGS except pass it on to some other function, it is > enough for the doc of the first function to say that - as usual. I have now done that. > Certainly the function's doc should say nothing about "NEW-WINDOW" > unless either NEW-WINDOW is in the parameter list or the doc > describes it in terms of parameters that are in the list (e.g., > as one of the members of argument-list ARGS). The mention of > NEW-WINDOW comes out of the blue and is incomprehensible to a > user reading the doc string (this user, at least). Fixed. > > > As for `browse-url-default-browser', its doc string does not > > > even have the lame excuse you used: > > > > The doc string says "Passes any ARGS to the browser function." > > > It says nothing at all about ARGS. > > > > Because it is just a dispatcher -- it invokes other functions, > > which mostly ignore ARGS altogether. > > Then that's what its doc should say: it passes ARGS to other > functions (and name or otherwise specify what those functions > are or can be). And whether or not those other functions ignore > ARGS is irrelevant to _this_ doc string for _this_ function. Done. > Back to the report... You dropped this: > > > And yet something about an "optional second argument > > NEW-WINDOW", which is not even present in the lambda list. > > What about that? No doc bug? Fixed. > And this: > > > Worse yet: It says "When called non-interactively", > > suggesting that the function could be called interactively. > > But it cannot - it is not a command. > > No acknowledgment that I might have a point and there are > indeed some problems with this doc string, there at least. The previous paragraph of the doc string describes the interactive behavior: When called interactively, if variable `browse-url-new-window-flag' is non-nil, load the document in a new window, if possible, otherwise use a random existing one. A non-nil interactive prefix argument reverses the effect of `browse-url-new-window-flag'. So this part was already okay (in other functions as well).