all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Ulrich Mueller <ulm@gentoo.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: Re: completing-read, incomplete documentation for "programmed completion"
Date: Mon, 5 Jan 2009 10:17:46 +0100	[thread overview]
Message-ID: <18785.53306.470861.421529@a1ihome1.kph.uni-mainz.de> (raw)
In-Reply-To: <jwvaba6jy22.fsf-monnier+emacs@gnu.org>

>>>>> On Sun, 04 Jan 2009, Stefan Monnier wrote:

> ...and the etc/NEWS file mentions that completion-boundaries is new
> and is not yet documented in the Elisp manual.

Yeah, but the Elisp manual was not my point. I was mainly speaking
about the functions' docstrings.

Here is another one, `complete-with-action', where the docstring does
not agree with the code:

,----
| (complete-with-action ACTION TABLE STRING PRED)
| 
| Perform completion ACTION.
| STRING is the string to complete.
| TABLE is the completion table, which should not be a function.
| PRED is a completion predicate.
| ACTION can be one of nil, t or `lambda'.
`----

Also, the different behaviour of `completing-read' breaks backwards
compatibility. In fact, I stumbled across this because of some lisp
code doing "programmed completion", which doesn't work properly with
Emacs 23 anymore (because it accounts only for nil, t, and `lambda').

So I think that proper documentation is important here.

Ulrich




  reply	other threads:[~2009-01-05  9:17 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-01-05  0:59 completing-read, incomplete documentation for "programmed completion" Ulrich Mueller
2009-01-05  2:18 ` Stefan Monnier
2009-01-05  9:17   ` Ulrich Mueller [this message]
2009-01-05 22:13     ` Stefan Monnier

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

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

  git send-email \
    --in-reply-to=18785.53306.470861.421529@a1ihome1.kph.uni-mainz.de \
    --to=ulm@gentoo.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.