From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#34794: 26.1; doc of `read-buffer' Date: Sat, 09 Mar 2019 20:16:22 +0200 Message-ID: <83r2bf7w21.fsf@gnu.org> References: <> <<831s3g7zv1.fsf@gnu.org>> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="32536"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 34794@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Mar 09 19:17:10 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.0:RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1h2gX0-0008MN-7G for geb-bug-gnu-emacs@m.gmane.org; Sat, 09 Mar 2019 19:17:10 +0100 Original-Received: from localhost ([127.0.0.1]:33900 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h2gWz-0000bq-2V for geb-bug-gnu-emacs@m.gmane.org; Sat, 09 Mar 2019 13:17:09 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:52788) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h2gWt-0000ba-J5 for bug-gnu-emacs@gnu.org; Sat, 09 Mar 2019 13:17:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h2gWs-0001ZC-72 for bug-gnu-emacs@gnu.org; Sat, 09 Mar 2019 13:17:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:52066) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h2gWs-0001Yz-33 for bug-gnu-emacs@gnu.org; Sat, 09 Mar 2019 13:17:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1h2gWr-0003Qk-Tq for bug-gnu-emacs@gnu.org; Sat, 09 Mar 2019 13:17:01 -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, 09 Mar 2019 18:17:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 34794 X-GNU-PR-Package: emacs Original-Received: via spool by 34794-submit@debbugs.gnu.org id=B34794.155215541913175 (code B ref 34794); Sat, 09 Mar 2019 18:17:01 +0000 Original-Received: (at 34794) by debbugs.gnu.org; 9 Mar 2019 18:16:59 +0000 Original-Received: from localhost ([127.0.0.1]:37377 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1h2gWp-0003QQ-Ih for submit@debbugs.gnu.org; Sat, 09 Mar 2019 13:16:59 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:38376) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1h2gWn-0003QD-NO for 34794@debbugs.gnu.org; Sat, 09 Mar 2019 13:16:58 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:33844) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h2gWi-0001SQ-IY; Sat, 09 Mar 2019 13:16:52 -0500 Original-Received: from [176.228.60.248] (port=1257 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1h2gWd-0007WK-At; Sat, 09 Mar 2019 13:16:50 -0500 In-reply-to: (message from Drew Adams on Sat, 9 Mar 2019 09:43:40 -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: 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:156197 Archived-At: > Date: Sat, 9 Mar 2019 09:43:40 -0800 (PST) > From: Drew Adams > Cc: 34794@debbugs.gnu.org > > > > AFAICT neither the doc string nor the Elisp manual states what the > > > default value is if argument DEF is nil. IOW, what is the default > > > buffer name if no explicit default is provided? It seems (without > > > thorough testing) to be the value of `(buffer-name (current-buffer))'. > > > > No, it's an empty string, and I think the doc string already conveys > > that. > > I cannot tell from the doc string that the default value, > i.e., the value returned when DEF is nil, is the empty > string. Optional second arg DEF is value to return if user enters an empty line. Doesn't this say that when DEF is omitted the function will return that empty line? > > (Note that if read-buffer-function is non-nil, what happens > > then is entirely up to that function, which doesn't make it easy to > > say exactly how DEF is handled.) > > It's not hard to state what the default DEF behavior > is, and then later say that if `read-buffer-function' > is non-nil then the use of the other args is up to it, > i.e., not necessarily as described above. This is > not unusual for a function that optionally accepts a > function arg as one possibility. Please suggest such a text, because I definitely don't see an easy way of saying that, without triggering more bug reports like this one.