From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#30958: 26.0.91; No documentation for key and value in the function passed to `map-keymap' Date: Tue, 27 Mar 2018 07:27:31 -0700 (PDT) Message-ID: <2e495171-34f8-436e-9fc5-334bd93fde00@default> References: <4f0b5f4f-74bd-5610-0cff-14da7ca90f39@topbug.net> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1522160826 26275 195.159.176.226 (27 Mar 2018 14:27:06 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 27 Mar 2018 14:27:06 +0000 (UTC) Cc: 30958@debbugs.gnu.org To: Andreas Schwab , Hong Xu Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Mar 27 16:27:02 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f0pYy-0006gb-AZ for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Mar 2018 16:27:00 +0200 Original-Received: from localhost ([::1]:34606 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f0pb1-0006vf-NR for geb-bug-gnu-emacs@m.gmane.org; Tue, 27 Mar 2018 10:29:07 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48532) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f0pa1-0006Fg-1g for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 10:28:10 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f0pZy-0004Hi-CR for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 10:28:05 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48200) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f0pZy-0004HN-4s for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 10:28:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f0pZx-0007sE-Ks for bug-gnu-emacs@gnu.org; Tue, 27 Mar 2018 10:28: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: Tue, 27 Mar 2018 14:28:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 30958 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 30958-submit@debbugs.gnu.org id=B30958.152216086430241 (code B ref 30958); Tue, 27 Mar 2018 14:28:01 +0000 Original-Received: (at 30958) by debbugs.gnu.org; 27 Mar 2018 14:27:44 +0000 Original-Received: from localhost ([127.0.0.1]:56097 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f0pZg-0007rh-0c for submit@debbugs.gnu.org; Tue, 27 Mar 2018 10:27:44 -0400 Original-Received: from aserp2130.oracle.com ([141.146.126.79]:54176) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f0pZe-0007rU-0R for 30958@debbugs.gnu.org; Tue, 27 Mar 2018 10:27:42 -0400 Original-Received: from pps.filterd (aserp2130.oracle.com [127.0.0.1]) by aserp2130.oracle.com (8.16.0.22/8.16.0.22) with SMTP id w2RE4LGa175035; Tue, 27 Mar 2018 14:27:35 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : cc : subject : references : in-reply-to : content-type : content-transfer-encoding; s=corp-2017-10-26; bh=1RDNhBxAqZVDcJSZ/aagKrJLR3egA/5alDOoNsCU/Pc=; b=NX8tvFc/pICxZOaNlPwRmsHlto3PTicjUxxUOcYDUc1s+/f2CGXh8pR43zZucDOXoOeh T9N9yCjkGaclF+p7YFwZejdPquGgy76mQhSXp+XdiVNk1bfo2sPaB4pZnJZBxLCZam3U MqA6Mlc+d2GeMZ0fk8F+lWa847bgr0Ko1tDixIpjYKrLF4PRtfHLD7d68y5Lahwn4XlT qSzANO5YHeKMZL9RfiAnsRXujzIO15u/jy5dv6dQ98uQFTSX8kBNnYbVbhR3kZio2uMY rLcweJBh65Uvs6Tr3EFud/J14jIAPkaNXXHCX6YSFnYckzem//1K0GLrWHv37R0IA6Cq OQ== Original-Received: from userv0022.oracle.com (userv0022.oracle.com [156.151.31.74]) by aserp2130.oracle.com with ESMTP id 2gyqc8g53j-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 27 Mar 2018 14:27:35 +0000 Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by userv0022.oracle.com (8.14.4/8.14.4) with ESMTP id w2RERXJ0002894 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Tue, 27 Mar 2018 14:27:34 GMT 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 w2RERW5e025361; Tue, 27 Mar 2018 14:27:32 GMT In-Reply-To: X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4666.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=8844 signatures=668695 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=991 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1711220000 definitions=main-1803270143 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" Xref: news.gmane.org gmane.emacs.bugs:144651 Archived-At: > > However, I searched the document, and could not find any useful > > information regarding the value of the binding. >=20 > It is whatever you've put there, see define-key. A keymap is really > just a mapping from a key to an arbitrary value, though if the keymap is > to be used as a local keymap each value should have one of the forms as > listed in the doc for define-key. Yes, I think that is the point: what a keymap is, and so what its entries are that are being mapped over. The key is to know or look up what a keymap is. Maybe this needs to be pointed out better in the doc string? Maybe the doc string should point users to the doc about keymaps? Typically we don't do that - if a user sees a term that is unclear we count on them looking it up. But maybe it's not clear from the doc string that the key here is to know what keymap is? I would think that that would be obvious, given that it is a function that maps over keymap entries. But maybe it's not. I don't really have a suggestion for this, but maybe Hong Xu does.