From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Philippe Vaucher Newsgroups: gmane.emacs.devel Subject: Re: tabulated-list sort icon is reversed Date: Sat, 9 Mar 2019 18:08:02 +0100 Message-ID: References: <87d0v1lsns.fsf@fastmail.fm> <532F6D74-E21C-45A2-B85B-01133DE1E8A1@scratch.space> <6e662c5b-3d04-2157-6712-aadcb6077f2b@gmail.com> <83a7j0pzbh.fsf@gnu.org> <83sgwpm92r.fsf@gnu.org> <83imx1h4rm.fsf@gnu.org> <83tvglf8h0.fsf@gnu.org> <83r2bhaegh.fsf@gnu.org> <835zss84v0.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="0000000000006cfd350583ac63c5" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="13389"; mail-complaints-to="usenet@blaine.gmane.org" Cc: Stefan Monnier , Emacs developers To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Mar 09 18:09:11 2019 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:256) (Exim 4.89) (envelope-from ) id 1h2fTC-0003HQ-Qq for ged-emacs-devel@m.gmane.org; Sat, 09 Mar 2019 18:09:11 +0100 Original-Received: from localhost ([127.0.0.1]:33231 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h2fTB-0007EP-QG for ged-emacs-devel@m.gmane.org; Sat, 09 Mar 2019 12:09:09 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:43095) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h2fSd-0006xA-5L for emacs-devel@gnu.org; Sat, 09 Mar 2019 12:08:35 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h2fSc-0003fm-9W for emacs-devel@gnu.org; Sat, 09 Mar 2019 12:08:35 -0500 Original-Received: from mail-lj1-x22c.google.com ([2a00:1450:4864:20::22c]:40626) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h2fSZ-0003cR-5v; Sat, 09 Mar 2019 12:08:31 -0500 Original-Received: by mail-lj1-x22c.google.com with SMTP id w6so594577ljd.7; Sat, 09 Mar 2019 09:08:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=WIQMdBX+LLjgh/qYNjrIN09eRhSr5MfH7h6fO2JIMGo=; b=blpqGIw3STLhetN2l0xXxPh1L+Zwen5t5LF3zhKmkHTjlUcFNOn2dgyRRK8u8x3C+q sRRTVUGgZ29YPSL7dEySgyTISZetBnoYVLh1RCzC0nZMXM8s2KJqYBjRhhpoXdl0NsEc bnsVFMtglprXri0UJp/FOykc7HC3tnpXxNSE4zkq8xix6P2lQaX5SmTeS7KFaY+6FLkw RiEwFP61ELFrg810K3Gzr4P301BJt301WkQRE+4Kfm8xYNSFEPp/9viZi2HwRz17F/X7 W4AN3wn59uSS7jVJzViMSn/FpESz9Pn+5UsbME4rsIOZ3ZL42peKoMb4qMc314YQbptb meYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=WIQMdBX+LLjgh/qYNjrIN09eRhSr5MfH7h6fO2JIMGo=; b=RkJno20PoWGz5Xd6CYEKm0y0OWWluT8Qhqb86KoplyOeShEPNTdlnHXiDmOHhFVlMe 1fza6JQkLRFzTYltkNQCRN42xUhDCiSV7GbdWt5eqI+xAHOEEv10e7WEGYvfWVVTZuLl Jum2izzpo7X5n+f2xtqNIZPeUdLjez6up3L7A2AO007k5CecI87CJu9pWiT0apXxROcO YgOc5Rwcn64Q/u4ilAYDKnJhSmQKPVgTtuxY4l4+A2MDTz/uAyIRPLkK8ir6w21Udsfk 09TmWNXKY5jn6mcxeTMyFxr3l5US36Z8Bl2D6u+6sQ0HWCQ9sLhF0hAJW2QiqjoCBIVg h8Mg== X-Gm-Message-State: APjAAAVW4fGwIqS/pu9zjfff+Hw8Rb5BEnQ5FfSFzUwRSEXsNC0XCGCr 1y875XMVN/8zeLHPmDQhw3rpwKgRb+zf39pTd8NVwSnJ5w0= X-Google-Smtp-Source: APXvYqwUPnjFoDZOje7ZJPVNFUrWoTF+nG7LOEZNAaPl0HosIg8wRRa89C2/9p3w30viKWF1PJGIQkopi5+Kv+gfoKY= X-Received: by 2002:a2e:5b11:: with SMTP id p17mr11700030ljb.37.1552151309252; Sat, 09 Mar 2019 09:08:29 -0800 (PST) In-Reply-To: <835zss84v0.fsf@gnu.org> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::22c X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:233976 Archived-At: --0000000000006cfd350583ac63c5 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable > > > 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 ?=E2=96=BC > > + "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. Philippe --0000000000006cfd350583ac63c5 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
> About the manual, given it's the first time I e= dit 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

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

Will do.

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

The first line of the doc string should be a single complete sentence.
<= /blockquote>

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


> +buffers for text-mode frames. This table is used for displ= aying the
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2= =A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0^^
Two spaces between sentences, please.

A= h, I didn't know that rule. Thanks.

Philippe= =C2=A0=C2=A0
--0000000000006cfd350583ac63c5--