[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: tabulated-list sort icon is reversed

From: Philippe Vaucher
Subject: Re: tabulated-list sort icon is reversed
Date: Sat, 9 Mar 2019 18:08:02 +0100

> About the manual, given it's the first time I edit it I went for a very minimalist approach, please tell me if I should
> mention the default values, or the type of the defcustom in there.

What is needed is a bit more descriptive text about these options.
You could write that text only once, for the first option, and in the
others say something like

  Like @code{tabulated-list-gui-sort-indicator-asc}, but used
  when ...

Will do.

> +(defcustom tabulated-list-gui-sort-indicator-asc ?▼
> + "Indicator for column sorted in ascending order, for GUI frames. See
> +  `tabulated-list-tty-sort-indicator-asc' for indicator used on
> +  text-mode frames."

The first line of the doc string should be a single complete sentence.

Just to be clear, if I wrote "It is the indicator used for the column sorted in ascending order (for GUI frames)." would that be ok? I know a complete sentence is subject + verb + complement but sometimes I have trouble figuring what is missing.

> +buffers for text-mode frames. This table is used for displaying the
Two spaces between sentences, please.

Ah, I didn't know that rule. Thanks.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]