From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#8693: 24.0.50; doc strings in syntax.el Date: Thu, 28 Apr 2016 12:59:47 +0200 Message-ID: <87eg9qov6k.fsf@gnus.org> References: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1461841290 3390 80.91.229.3 (28 Apr 2016 11:01:30 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 28 Apr 2016 11:01:30 +0000 (UTC) Cc: 8693@debbugs.gnu.org To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Apr 28 13:01:17 2016 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 1avjh7-0002LB-CZ for geb-bug-gnu-emacs@m.gmane.org; Thu, 28 Apr 2016 13:01:17 +0200 Original-Received: from localhost ([::1]:47948 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avjh6-00063Z-RB for geb-bug-gnu-emacs@m.gmane.org; Thu, 28 Apr 2016 07:01:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:49320) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avjgw-0005oP-JZ for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 07:01:12 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1avjgs-0004zf-Hx for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 07:01:06 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:38956) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1avjgs-0004zb-Dm for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 07:01:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1avjgs-0004c3-7i for bug-gnu-emacs@gnu.org; Thu, 28 Apr 2016 07:01:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 28 Apr 2016 11:01:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 8693 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 8693-submit@debbugs.gnu.org id=B8693.146184120314583 (code B ref 8693); Thu, 28 Apr 2016 11:01:02 +0000 Original-Received: (at 8693) by debbugs.gnu.org; 28 Apr 2016 11:00:03 +0000 Original-Received: from localhost ([127.0.0.1]:51288 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1avjfr-0003lm-JN for submit@debbugs.gnu.org; Thu, 28 Apr 2016 07:00:03 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:35280) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1avjfm-0003lV-T8 for 8693@debbugs.gnu.org; Thu, 28 Apr 2016 06:59:58 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1avjff-0001AS-W6; Thu, 28 Apr 2016 12:59:51 +0200 In-Reply-To: (Lars Magne Ingebrigtsen's message of "Fri, 15 Jul 2011 15:53:21 +0200") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) 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:117031 Archived-At: Lars Magne Ingebrigtsen writes: >> 2. In doc strings of `syntax-propertize-function' and >> `syntax-propertize-extend-region-functions': Please describe >> START and END: their meanings and possible values (type). >> Likewise NEW-START and NEW-END. This seems like it has been fixed... >> 3. IN doc string of `syntax-propertize-rules': >> "if SYNTAX has the form (prog1 EXP . EXPS) then the value >> returned by EXP will be applied to the buffer before running >> EXPS and if EXP is a string it is also converted with >> `string-to-syntax'." >> Need descriptions of what EXP and EXPs are: meanings and possible values >> (types). I think the natural interpretation here is that EXP is of the same type as SYNTAX otherwise described. (And EXPS is a list of whatever that is.) >> 4. Doc string of `syntax-propertize-via-font-lock': >> "Propertize for syntax in START..END using font-lock syntax..." >> There are no parameters START, END. Please describe them and >> relate them to the function. Fixed. >> 5. Doc string of `syntax-propertize': It would be clearer if POS were >> described (e.g. as a buffer position). Same thing elsewhere that the meaning >> might not be obvious. (Calling it POSITION would pretty much obviate the need >> for a description.) I've clarified. >> 6. Doc string of `syntax-ppss-cache': Describe POS and PPSS. >> >> 7. Doc string of `syntax-ppss-last': Describe LAST-POS and LAST-PPSS. Seems unnecessary for these internal things. >> 8. Doc string of `syntax-ppss-flush-cache': Describe parameter >> IGNORED. It's... ignored. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no