From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#35222: 26.1; `read-command' documentation Date: Wed, 10 Apr 2019 15:13:31 -0700 (PDT) Message-ID: <54098355-6406-459c-9a3a-b7c5b4fe286b@default> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="208298"; mail-complaints-to="usenet@blaine.gmane.org" To: 35222@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Apr 11 00:14: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 1hELTu-000s5i-2Y for geb-bug-gnu-emacs@m.gmane.org; Thu, 11 Apr 2019 00:14:10 +0200 Original-Received: from localhost ([127.0.0.1]:38474 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hELTt-0005fh-0w for geb-bug-gnu-emacs@m.gmane.org; Wed, 10 Apr 2019 18:14:09 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:33481) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hELTn-0005fc-0n for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:14:03 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hELTm-0001BG-5i for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:14:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:40097) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hELTl-0001AL-VT for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:14:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hELTl-0004iM-Mw for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:14:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 10 Apr 2019 22:14:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 35222 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.155493442918094 (code B ref -1); Wed, 10 Apr 2019 22:14:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 10 Apr 2019 22:13:49 +0000 Original-Received: from localhost ([127.0.0.1]:53641 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hELTY-0004hm-P9 for submit@debbugs.gnu.org; Wed, 10 Apr 2019 18:13:49 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:47239) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hELTU-0004hU-M5 for submit@debbugs.gnu.org; Wed, 10 Apr 2019 18:13:47 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:37866) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hELTP-0000li-Ie for submit@debbugs.gnu.org; Wed, 10 Apr 2019 18:13:39 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:33381) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hELTO-0005fA-Cd for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:13:39 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hELTN-0000jA-EK for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:13:38 -0400 Original-Received: from userp2120.oracle.com ([156.151.31.85]:40696) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hELTM-0000c6-5N for bug-gnu-emacs@gnu.org; Wed, 10 Apr 2019 18:13:36 -0400 Original-Received: from pps.filterd (userp2120.oracle.com [127.0.0.1]) by userp2120.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x3AMAOQb103969 for ; Wed, 10 Apr 2019 22:13:34 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=+0Q0CiuaOzXyhZsw/PUEaS6zxmrX1JozVVfKwvPNrn8=; b=AFeVBvZww5t7v243L+PObbxeIN7heBxkFpyf70FQmavnHGvPQHUFZ7V/djGWDIkx46N2 VCuKE4SVGFPXiqxsjqRYscEgEF9xG/ZhH37haU029HzpUya2EO2rqPmHqhTPunxBK6n7 kr83lb+L27VH5EgpHpF6AIcfLBRnVxi4u9zgkf1bomxJyLuWN0bs2894WBbDfSjva1rI eCdBtOKzdKcFfx/RJhT1MZFsvo+RIrr84bP5CDBQL5GClRU4p8w68yKsckM/ca0zfyKN zgGwjfM6Jv2D0ZFLwcU9djr+VVfpTewS3HtNstoBz5SIjX4I/4n1wOHF58iO92R8puSP kw== Original-Received: from aserp3020.oracle.com (aserp3020.oracle.com [141.146.126.70]) by userp2120.oracle.com with ESMTP id 2rpmrqdkdr-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 10 Apr 2019 22:13:34 +0000 Original-Received: from pps.filterd (aserp3020.oracle.com [127.0.0.1]) by aserp3020.oracle.com (8.16.0.27/8.16.0.27) with SMTP id x3AMBfge045787 for ; Wed, 10 Apr 2019 22:13:33 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserp3020.oracle.com with ESMTP id 2rpytcg06c-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 10 Apr 2019 22:13:33 +0000 Original-Received: from abhmp0014.oracle.com (abhmp0014.oracle.com [141.146.116.20]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id x3AMDWqt006393 for ; Wed, 10 Apr 2019 22:13:33 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4834.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9223 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1904100144 X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9223 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=1 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1904100144 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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:157470 Archived-At: 1. The doc string does not say what happens if DEFAULT is not provided (so `nil') and the user enters empty input. And what happens is not obvious. Please add that information to the doc string. 2. What does happen? Well, it's documented in (elisp) `High-Level Completion'. But please add information to that Info node that helps users understand a return value that is an empty-named interned symbol, which has the print and read syntax `##'. It's pretty unusual for the default behavior of a read command to return such an odd beast. (The default behavior is the case when arg DEFAULT is absent, hence `nil'.) And please provide a cross-reference to node `Symbol Type', which explains this syntax. User code that tests the result of `read-command' typically needs to deal with the default DEFAULT case, hence with the possibility of the function returning an uninterned symbol. Users need to be aware of this possibility - it's a gotcha. In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32) of 2018-05-30 Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea Windowing system distributor `Microsoft Corp.', version 10.0.17134 Configured using: `configure --without-dbus --host=3Dx86_64-w64-mingw32 --without-compress-install 'CFLAGS=3D-O2 -static -g3''