unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: 8693@debbugs.gnu.org
Subject: bug#8693: 24.0.50; doc strings in syntax.el
Date: Thu, 28 Apr 2016 06:55:14 -0700 (PDT)	[thread overview]
Message-ID: <819e08b3-2c1e-4602-807f-63bafabca44a@default> (raw)
In-Reply-To: <87eg9qov6k.fsf@gnus.org>

> >> 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.)

There is no "natural interpretation".  Such things need to be
specified.  If Emacs Dev knows what the meaning/behavior is
then it should specify it.  If it does not know then it should
not expect users to guess.

> >> 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.

They are not internal.  Programmers who use these functions
deserve to know what their parameters are.  This is why we
have doc strings.





      reply	other threads:[~2016-04-28 13:55 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-05-18 16:14 bug#8693: 24.0.50; doc strings in syntax.el Drew Adams
2011-05-18 16:28 ` Drew Adams
2011-05-18 22:10   ` Stefan Monnier
2011-05-18 22:46     ` Drew Adams
2011-07-15 13:53 ` Lars Magne Ingebrigtsen
2011-07-15 15:09   ` Drew Adams
2016-04-28 10:59   ` Lars Ingebrigtsen
2016-04-28 13:55     ` Drew Adams [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=819e08b3-2c1e-4602-807f-63bafabca44a@default \
    --to=drew.adams@oracle.com \
    --cc=8693@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).