From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#44451: 27.1; doc string of `read-char-from-minibuffer' Date: Wed, 4 Nov 2020 10:40:01 -0800 (PST) Message-ID: <06536d27-20de-407a-b79a-a633c0c459a3@default> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="16946"; mail-complaints-to="usenet@ciao.gmane.io" To: 44451@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Nov 04 19:59:34 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1kaO0M-0004Il-8M for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 04 Nov 2020 19:59:34 +0100 Original-Received: from localhost ([::1]:60444 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kaO0L-0005Go-9H for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 04 Nov 2020 13:59:33 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52904) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kaNkM-0002RO-K6 for bug-gnu-emacs@gnu.org; Wed, 04 Nov 2020 13:43:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:39032) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kaNkM-0002AT-Am for bug-gnu-emacs@gnu.org; Wed, 04 Nov 2020 13:43:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1kaNkM-0003tm-76 for bug-gnu-emacs@gnu.org; Wed, 04 Nov 2020 13:43:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 04 Nov 2020 18:43:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 44451 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.160451533914933 (code B ref -1); Wed, 04 Nov 2020 18:43:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 4 Nov 2020 18:42:19 +0000 Original-Received: from localhost ([127.0.0.1]:50578 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kaNjf-0003sn-D1 for submit@debbugs.gnu.org; Wed, 04 Nov 2020 13:42:19 -0500 Original-Received: from lists.gnu.org ([209.51.188.17]:35960) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1kaNja-0003sc-T9 for submit@debbugs.gnu.org; Wed, 04 Nov 2020 13:42:18 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52524) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kaNja-0001Mh-IZ for bug-gnu-emacs@gnu.org; Wed, 04 Nov 2020 13:42:14 -0500 Original-Received: from aserp2120.oracle.com ([141.146.126.78]:34278) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kaNjY-00024H-3X for bug-gnu-emacs@gnu.org; Wed, 04 Nov 2020 13:42:13 -0500 Original-Received: from pps.filterd (aserp2120.oracle.com [127.0.0.1]) by aserp2120.oracle.com (8.16.0.42/8.16.0.42) with SMTP id 0A4IXSHt016286 for ; Wed, 4 Nov 2020 18:42:07 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-2020-01-29; bh=CTllfWMAcXX9xa2ZQ4PmfQ8ER++V2wt5QcBAuHYQ7oM=; b=rKdKjsUUl2KIA7gRrOzeTgkESNiCXA96eJ1oIlDI/bChLqNaRaugtsX/Oh2rV7VrfZA/ CGquC+ymA9wa1Dnzm5vELB3jxpHMR01oRH4MGeoLlzCO4hWEe0vllHLRrc1J63kNL22R MrapPf3i00GOTVM6yNFUuY1uUcDsk4zFo7AXxsvnvcJ9HAJp8SntdbWtNcmPeD5lQfOA o0N1J1N/4lhqRWXBnFb1PySBlARsfsikFmQJrRvMYWu1Wihlk6pZsBm903V+GoImlLAY rc87qUTCz9XjEhqsp0VoI+4eQLdJI0bynYdS68dFJQzUtxjd3jHwB/zr7qbJJfyA0QNN pg== Original-Received: from userp3020.oracle.com (userp3020.oracle.com [156.151.31.79]) by aserp2120.oracle.com with ESMTP id 34hhvcgakw-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL) for ; Wed, 04 Nov 2020 18:42:06 +0000 Original-Received: from pps.filterd (userp3020.oracle.com [127.0.0.1]) by userp3020.oracle.com (8.16.0.42/8.16.0.42) with SMTP id 0A4IYjD3088371 for ; Wed, 4 Nov 2020 18:40:06 GMT Original-Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75]) by userp3020.oracle.com with ESMTP id 34hw0fxqrn-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Wed, 04 Nov 2020 18:40:06 +0000 Original-Received: from abhmp0014.oracle.com (abhmp0014.oracle.com [141.146.116.20]) by userv0122.oracle.com (8.14.4/8.14.4) with ESMTP id 0A4Ie2uZ025605 for ; Wed, 4 Nov 2020 18:40:03 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.5056.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9795 signatures=668682 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 mlxlogscore=838 phishscore=0 bulkscore=0 spamscore=0 malwarescore=0 mlxscore=0 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2011040135 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9795 signatures=668682 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 suspectscore=1 impostorscore=0 malwarescore=0 priorityscore=1501 mlxlogscore=852 bulkscore=0 phishscore=0 adultscore=0 mlxscore=0 lowpriorityscore=0 clxscore=1015 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2011040135 Received-SPF: pass client-ip=141.146.126.78; envelope-from=drew.adams@oracle.com; helo=aserp2120.oracle.com X-detected-operating-system: by eggs.gnu.org: First seen = 2020/11/04 13:42:08 X-ACL-Warn: Detected OS = Linux 3.1-3.10 [fuzzy] X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:192680 Archived-At: "Read a character from the minibuffer, prompting for PROMPT." You are not prompted for PROMPT. You are prompted (for a char) with PROMPT. "When HISTORY is a symbol, then allows navigating in a history." English: it should be "When...symbol, allow navigating..." But it's not clear what "navigating in a history" means. The description of `M-n' etc. isn't clear - or needed. And what if HISTORY is non-nil but not a symbol? In any case, I suggest you just say that HISTORY is passed to `read-from-minibuffer', which is the case. That function's HISTORY description is clear and complete, and it involves more than what is described here. In GNU Emacs 27.1 (build 1, x86_64-w64-mingw32) of 2020-08-12 built on CIRROCUMULUS Repository revision: 86d8d76aa36037184db0b2897c434cdaab1a9ae8 Repository branch: HEAD Windowing system distributor 'Microsoft Corp.', version 10.0.18362 System Description: Microsoft Windows 10 Pro (v10.0.1903.18362.1082)