all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Yuan Fu <casouri@gmail.com>
Cc: emacs-devel@gnu.org
Subject: Re: Tree-sitter documentation
Date: Mon, 07 Nov 2022 14:11:55 +0200	[thread overview]
Message-ID: <83a653ynec.fsf@gnu.org> (raw)
In-Reply-To: <48A65188-BBC6-442F-A552-5FEA1416F936@gmail.com> (message from Yuan Fu on Mon, 7 Nov 2022 02:13:20 -0800)

> From: Yuan Fu <casouri@gmail.com>
> Date: Mon, 7 Nov 2022 02:13:20 -0800
> 
> > This function takes a series of @var{query-spec}s, which are triplets
> > @w{@code{@var{:keyword} @var{value} @dots{} @var{query}}}.  Each
> > @var{query} is a tree-sitter query in either the string, s-expression
> > or compiled form.
> > 
> Is is ok to use “triplets” here? Because there can be more than one pair of :keyword and values before a query, eg,
> 
> :keyword value
> :keyword value
> query

In that case, "triplets" is definitely incorrect, but I had no way of
understanding that this is possible.

It should be possible top describe this kind of argument list, but
does it really have to be so complicated?  These are not internal
functions, so Lisp programmers will have to battle with this signature
all the time.  Can we make the function's signature easier to
document, understand, and use?

For example, what about accepting an alist as the argument, where each
alist element specifies a query and its keyword/value pairs that
customize the query?



  reply	other threads:[~2022-11-07 12:11 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-07 10:13 Tree-sitter documentation Yuan Fu
2022-11-07 12:11 ` Eli Zaretskii [this message]
2022-11-07 20:47   ` Yuan Fu
2022-11-08 14:40     ` Eli Zaretskii
2022-11-08 15:36       ` Stefan Kangas
2022-11-08 18:44       ` Yuan Fu
2022-11-09 13:36         ` Eli Zaretskii

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=83a653ynec.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=casouri@gmail.com \
    --cc=emacs-devel@gnu.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 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.