From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#16312: 24.3.50; Docstring fix for `set-transient-map' (and tangents...) Date: Wed, 1 Jan 2014 07:54:41 -0800 (PST) Message-ID: <94f6fcc0-6c5e-45d9-9e78-951440fa7019@default> References: <55769.202.78.240.7.1388455781.squirrel@mail.orcon.net.nz> <52C386FA.6040709@orcon.net.nz> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1388591719 4635 80.91.229.3 (1 Jan 2014 15:55:19 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 1 Jan 2014 15:55:19 +0000 (UTC) To: Phil Sainty , 16312@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jan 01 16:55:24 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1VyO8h-0005ya-Th for geb-bug-gnu-emacs@m.gmane.org; Wed, 01 Jan 2014 16:55:24 +0100 Original-Received: from localhost ([::1]:41719 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VyO8h-0008UO-GK for geb-bug-gnu-emacs@m.gmane.org; Wed, 01 Jan 2014 10:55:23 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52197) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VyO8V-0008Su-D5 for bug-gnu-emacs@gnu.org; Wed, 01 Jan 2014 10:55:19 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VyO8M-0004vO-NQ for bug-gnu-emacs@gnu.org; Wed, 01 Jan 2014 10:55:11 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:42185) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VyO8M-0004uv-Je for bug-gnu-emacs@gnu.org; Wed, 01 Jan 2014 10:55:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1VyO8M-000801-0H for bug-gnu-emacs@gnu.org; Wed, 01 Jan 2014 10:55: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, 01 Jan 2014 15:55:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 16312 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 16312-submit@debbugs.gnu.org id=B16312.138859168830727 (code B ref 16312); Wed, 01 Jan 2014 15:55:01 +0000 Original-Received: (at 16312) by debbugs.gnu.org; 1 Jan 2014 15:54:48 +0000 Original-Received: from localhost ([127.0.0.1]:56204 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VyO88-0007zW-4x for submit@debbugs.gnu.org; Wed, 01 Jan 2014 10:54:48 -0500 Original-Received: from userp1040.oracle.com ([156.151.31.81]:45511) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VyO86-0007zO-2X for 16312@debbugs.gnu.org; Wed, 01 Jan 2014 10:54:46 -0500 Original-Received: from ucsinet21.oracle.com (ucsinet21.oracle.com [156.151.31.93]) by userp1040.oracle.com (Sentrion-MTA-4.3.1/Sentrion-MTA-4.3.1) with ESMTP id s01FsiON012951 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Wed, 1 Jan 2014 15:54:45 GMT Original-Received: from aserz7022.oracle.com (aserz7022.oracle.com [141.146.126.231]) by ucsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s01FshtY008276 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Wed, 1 Jan 2014 15:54:43 GMT Original-Received: from abhmp0002.oracle.com (abhmp0002.oracle.com [141.146.116.8]) by aserz7022.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s01Fsh7E012714; Wed, 1 Jan 2014 15:54:43 GMT In-Reply-To: <52C386FA.6040709@orcon.net.nz> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6680.5000 (x86)] X-Source-IP: ucsinet21.oracle.com [156.151.31.93] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:82800 Archived-At: > I also see the phrase "the keymap char property" in the docstring for > `overriding-local-map'. Should that read "the keymap text property"? Or > is this because there's a keymap Overlay property as well, and the > `get-char-property' function checks them both? (This seems likely, but > might imply that the reference to "the `keymap' text property" in > set-transient-map is insufficient, iff that also needs to cover overlay > properties?) >=20 > I'm afraid I'm not very familiar with text properties and overlays, so > I'm not sure which is the preferred term here. I would imagine that > this issue (with two types of 'keymap' properties) might crop up in > a number of places, so perhaps there's already an agreed way of > describing it for documentation purposes? >=20 > I suspect this would be less confusing were it not for the info node > "(elisp) Character Properties" which is unconnected to `get-char-property= ' > (instead we have `get-char-code-property' to obtain these "Character > Properties". It seems to me that this is mostly an unfortunate naming > clash with a standard Unicode term, but as such the info nodes could > probably benefit from some up-front clarifications to make the distinctio= n > between the two types of "char property" and associated function naming > schemes clear from the outset? >=20 > Perhaps the "Character Properties" node should even be renamed to > "Character Code Properties" to better align with the function names? > This concept in Emacs sounds as if it's a super-set of the Unicode > Character Property Model, so it possibly doesn't *need* to have that > exact name? Eli has pointed out elsewhere that "character property" properly belongs to the sense of node "Character Properties", so that it should not be used also to refer to both text properties and overlay properties. IOW, `get-char-property' is misnamed. Its name should not be taken as a guide to documenting text & overlay properties as "character" properties. I too was confused about this, and had suggested updating some doc to use "character property" to refer to both text & overlay properties. In fact, I used it that way in my own code (doc and function names). Based on Eli's explanation, I corrected my code in this regard. It might even be good to rename `get-char-property' (keeping the original name for backward compatibility, of course).