Re: tabulated-list sort icon is reversed

[Eli Zaretskii <eliz@gnu.org>]

> From: Philippe Vaucher <philippe.vaucher@gmail.com>
> Date: Sat, 2 Mar 2019 20:06:49 +0100
> Cc: Stefan Monnier <monnier@iro.umontreal.ca>, Emacs developers <emacs-devel@gnu.org>
> 
> Here we go. I'm not familiar with the NEWS redaction so feel free to change the text.

Thanks.  See some minor comments below.

Also, what about updating the Emacs user manual with the description
of the new user options?

> (tabulated-list-gui-sort-indicator-asc): New defcustom.
> (tabulated-list-gui-sort-indicator-desc): New defcustom.
> (tabulated-list-tty-sort-indicator-asc): New defcustom.
> (tabulated-list-tty-sort-indicator-desc): New defcustom.

This is not wrong, but could be abbreviated:

(tabulated-list-gui-sort-indicator-asc)
(tabulated-list-gui-sort-indicator-desc)
(tabulated-list-tty-sort-indicator-asc)
(tabulated-list-tty-sort-indicator-desc): New defcustom.

> (tabulated-list-glyphless-char-display): Removal.

We use "Removed".

> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -279,6 +279,15 @@ matches strings where the pattern appears as a subsequence.  Put
>  simply, makes "foo" complete to both "barfoo" and "frodo".  Add 'flex'
>  to 'completion-styles' or 'completion-category-overrides' to use it.
>  
> ++++

the "+++" marker means the manuals have been updated, but I don't see
the patch for the manuals.

> +** New user options for tabulated list sort indicators

The header should end in a period.

> +The user can customize which sorting indicator character to display
> +near the current column in Tabulated Lists:
> +- tabulated-list-gui-sort-indicator-asc
> +- tabulated-list-gui-sort-indicator-desc
> +- tabulated-list-tty-sort-indicator-asc
> +- tabulated-list-tty-sort-indicator-desc

We don't use itemized lists in NEWS, and also we quote Lisp symbols
'like this'.

> +(defcustom tabulated-list-gui-sort-indicator-asc ?▼
> +  "GUI indicator displayed near the current column when the sort order
> +is ascending."

the first line of a doc string should be a single complete sentence,
fr the benefit of the apropos* commands, which only show the first
line.  If the first sentence is too long, say the most important part
in the first sentence, and leave the details for the rest of the doc
string.  In this case, I'd suggest something like this:

    "Indicator for column sorted in ascending order, for GUI frames.
  See `tabulated-list-tty-sort-indicator-asc' for indicator used on
  text-mode frames."

> -(defvar tabulated-list-glyphless-char-display
> +(defun tabulated-list-make-glyphless-char-display-table ()
> +  "Make the `glyphless-char-display' table used in Tabulated List buffers."

I'd suggest to mention here that this table is used for displaying the
soring indicators.