From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Magne Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#8693: 24.0.50; doc strings in syntax.el Date: Fri, 15 Jul 2011 15:53:21 +0200 Message-ID: References: NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1310738655 2645 80.91.229.12 (15 Jul 2011 14:04:15 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 15 Jul 2011 14:04:15 +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 Fri Jul 15 16:04:08 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1Qhizv-0006OP-Sp for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 16:04:08 +0200 Original-Received: from localhost ([::1]:34739 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhizu-0004zk-DW for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Jul 2011 10:04:06 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:52881) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhiy0-0004XW-8c for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 10:02:13 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Qhixw-0000NX-0H for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 10:02:07 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:36327) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Qhixv-0000NM-Kv for bug-gnu-emacs@gnu.org; Fri, 15 Jul 2011 10:02:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1Qhixu-0000Ro-TP; Fri, 15 Jul 2011 10:02:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Magne Ingebrigtsen Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Jul 2011 14:02: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.13107384861658 (code B ref 8693); Fri, 15 Jul 2011 14:02:02 +0000 Original-Received: (at 8693) by debbugs.gnu.org; 15 Jul 2011 14:01:26 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhixJ-0000Qd-O4 for submit@debbugs.gnu.org; Fri, 15 Jul 2011 10:01:26 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QhixH-0000QJ-1K for 8693@debbugs.gnu.org; Fri, 15 Jul 2011 10:01:24 -0400 Original-Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qhix4-0002qL-F5; Fri, 15 Jul 2011 16:01:10 +0200 In-Reply-To: (Drew Adams's message of "Wed, 18 May 2011 09:14:50 -0700") User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Joni Mitchell's _Miles of Aisles_: "Big Yellow Taxi" X-Hashcash: 1:23:110715:drew.adams@oracle.com::z59YW6bSa7ZgYPDH:0000000000000000000000000000000000000001UoIL X-Hashcash: 1:23:110715:8693@debbugs.gnu.org::N9wfWwONeDOTCEdg:000000000000000000000000000000000000000021EFe X-MailScanner-ID: 1Qhix4-0002qL-F5 MailScanner-NULL-Check: 1311343270.81853@eUq753CU/9IP/xF0tmHmKw X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 15 Jul 2011 10:02:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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:49133 Archived-At: "Drew Adams" writes: > 1. Everywhere in syntax.el, please change "upto" to "up to". > (Not English.) Two instances fixed. > 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. > > 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). > > 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. > > 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.) > > 6. Doc string of `syntax-ppss-cache': Describe POS and PPSS. > > 7. Doc string of `syntax-ppss-last': Describe LAST-POS and LAST-PPSS. > > 8. Doc string of `syntax-ppss-flush-cache': Describe parameter IGNORED. Do you have a suggestion for descriptions for these things? -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/