unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Tino Calancha <tino.calancha@gmail.com>
Cc: npostavs@gmail.com, 32731@debbugs.gnu.org
Subject: bug#32731: 26.1.50; Ibuffer filter by mode: Handle >1 mode names
Date: Wed, 19 Sep 2018 12:42:28 +0300	[thread overview]
Message-ID: <83sh25escb.fsf@gnu.org> (raw)
In-Reply-To: <877ejh96xj.fsf@calancha-pc.dy.bbexcite.jp> (message from Tino Calancha on Wed, 19 Sep 2018 18:23:52 +0900)

> From: Tino Calancha <tino.calancha@gmail.com>
> Date: Wed, 19 Sep 2018 18:23:52 +0900
> Cc: 32731@debbugs.gnu.org
> 
> Following patch adds a key :composable, which also serves as
> documentation.

Thanks, a few nits to the documentation parts:

>  ---
> +*** All mode filters accept a symbol or a list of symbols, i.e., you
> +can filter several major modes with easy.

Please try to keep the first line in a NEWS item a single complete
sentence, as much as possible: that allows for more convenient
browsing in Outline mode.  In this case, I would break this into two
sentences: a short announcement and followup details:

   *** All mode filters can now accept a list of symbols.
   This means you can now easily filter several major modes, as well
   as a single mode.

>  ;;;###autoload (autoload 'ibuffer-filter-by-mode "ibuf-ext")
>  (define-ibuffer-filter mode
> -  "Limit current view to buffers with major mode QUALIFIER."
> +  "Limit current view to buffers with major mode in QUALIFIER.
> +QUALIFIER is the mode name as a symbol or a list of symbols.

In the first sentence, I'd suggest to rephrase:

  Limit current view to buffers with major mode(s) specified by QUALIFIER.

because "in QUALIFIER" only covers the case of a list.

Similarly in other doc strings you modified the same way.

> +Called interactively, accept a comma separated list of mode names.
> +When called interactively, this function allows selection of modes
>  currently used by buffers."

These two sentences seem to be in contradiction, so they probably need
to be merged or rephrased.

>  (cl-defmacro define-ibuffer-filter (name documentation
>  				       (&key
>  					reader
> -					description)
> +					description
> +                                        composable)
>  				       &rest body)
>    "Define a filter named NAME.
>  DOCUMENTATION is the documentation of the function.
>  READER is a form which should read a qualifier from the user.
>  DESCRIPTION is a short string describing the filter.
> +COMPOSABLE is a boolean; if non-nil, the filter accepts both,
                                                               ^
That comma should be deleted, it gets in the way of understanding what
you mean.  And I would actually rephrase

  if non-nil, the filter accepts either a single condition or a list
  of them

because "both" might be interpreted as meaning "and", not "or".

I also wonder whether "COMPOSABLE" is a good name for this argument;
how about ACCEPT-LIST instead?

Thanks for working on this.





  reply	other threads:[~2018-09-19  9:42 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-13 18:19 bug#32731: 26.1.50; Ibuffer filter by mode: Handle >1 mode names Tino Calancha
2018-09-13 19:09 ` Noam Postavsky
2018-09-13 20:04   ` Tino Calancha
2018-09-13 20:38   ` Tino Calancha
2018-09-13 23:39     ` Noam Postavsky
2018-09-15  9:15       ` Tino Calancha
2018-09-15 12:42         ` Noam Postavsky
2018-09-17 17:44           ` Tino Calancha
2018-09-17 18:27             ` Eli Zaretskii
2018-09-17 19:53               ` Tino Calancha
2018-09-18  7:14                 ` Eli Zaretskii
2018-09-18 23:19             ` Noam Postavsky
2018-09-19  9:23               ` Tino Calancha
2018-09-19  9:42                 ` Eli Zaretskii [this message]
2018-09-21  8:37                   ` Tino Calancha
2018-09-22  9:14                     ` Eli Zaretskii
2018-09-22 13:00                     ` Noam Postavsky
2018-09-23  1:37                       ` Richard Stallman
2018-09-23 12:01                         ` Noam Postavsky
2018-09-24  8:27                         ` Tino Calancha
2018-09-24 19:58                           ` Richard Stallman
2018-09-24 20:48                             ` Tino Calancha
2018-09-24 21:14                               ` Eli Zaretskii
2018-09-25  8:14                                 ` Robert Pluim
2018-09-25  9:24                                   ` Eli Zaretskii
2018-09-25 23:03                                     ` Richard Stallman
2018-09-29  9:49                                   ` Tino Calancha
2018-09-24  8:36                       ` Tino Calancha

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=83sh25escb.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=32731@debbugs.gnu.org \
    --cc=npostavs@gmail.com \
    --cc=tino.calancha@gmail.com \
    /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).