GNU bug report logs - #19421
25.0.50; doc string of `browse-url' must describe parameter ARGS

Previous Next

Full log

View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: Eli Zaretskii <eliz <at> gnu.org>, Drew Adams <drew.adams <at> oracle.com>
Cc: larsi <at> gnus.org, 19421 <at> debbugs.gnu.org
Subject: bug#19421: 25.0.50;	doc string of `browse-url' must describe parameter ARGS
Date: Sun, 27 Dec 2015 08:55:18 -0800 (PST)

>> > I fail to see how it is called interactively, since it is not a
> > command - it has no `interactive' spec.
> 
> It describes what will happen with the functions it calls, depending
> on the platform.  Those functions do have an interactive spec.

That is something entirely different from "when called interactively".
Such language is quite misleading.  At least it misled and confused me.

And is this doc string really the place to describe that?  (I don't
say that it is not, but certainly such info is secondary to describing
this function and its own arguments.)

> > And it refers to an "optional second argument NEW-WINDOW", but
> > the lambda list is (URL &rest ARGS), and the doc string in no
> > way introduces NEW WINDOW in terms of those parameters.
> 
> Please look at the current sources, you are talking about stuff I
> changed already.

OK great.  Please ignore any such ignorance.  I was referring to
the state before your changes, which I have not seen.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.