From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Fill column indicator functionality Date: Wed, 03 Apr 2019 08:20:10 +0300 Message-ID: <83sguzekc5.fsf@gnu.org> References: <20190402133718.z464xomdq6l3pfrl@Ergus> <83pnq4fnte.fsf@gnu.org> <20190402153504.jfliuexzn4ntqnn4@Ergus> <83k1gcfm3y.fsf@gnu.org> <20190402163623.2gvlraa5qitzgi6y@Ergus> <83h8bgfj53.fsf@gnu.org> <20190402170031.l64saf2qdr3gez3u@Ergus> <83d0m4fhe6.fsf@gnu.org> <20190402174857.ydvsrgplftya4nti@Ergus> <83a7h8feho.fsf@gnu.org> <20190402212251.ee6jlzptyll24ebo@Ergus> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="31111"; mail-complaints-to="usenet@blaine.gmane.org" Cc: emacs-devel@gnu.org To: Ergus Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Apr 03 07:20:07 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 1hBYJh-0007xn-AO for ged-emacs-devel@m.gmane.org; Wed, 03 Apr 2019 07:20:05 +0200 Original-Received: from localhost ([127.0.0.1]:50526 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hBYJg-0005NZ-5W for ged-emacs-devel@m.gmane.org; Wed, 03 Apr 2019 01:20:04 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:35818) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hBYJZ-0005NI-OP for emacs-devel@gnu.org; Wed, 03 Apr 2019 01:19:58 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:48005) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hBYJZ-0002hO-6W; Wed, 03 Apr 2019 01:19:57 -0400 Original-Received: from [176.228.60.248] (port=2947 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1hBYJY-0002or-MY; Wed, 03 Apr 2019 01:19:57 -0400 In-reply-to: <20190402212251.ee6jlzptyll24ebo@Ergus> (message from Ergus on Tue, 2 Apr 2019 23:22:52 +0200) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:234913 Archived-At: > Date: Tue, 2 Apr 2019 23:22:52 +0200 > From: Ergus > Cc: emacs-devel@gnu.org > > I just uploaded a commit with a preliminary documentation in the file you > recommended. Thanks. > I am learning the texinfo format on the way, so I still need to learn > how to do a cross reference and other details (it is not trivial for a > markdown/rst/Latex user like me). I suggest to have the Texinfo manual open in your Emacs session at all times when you are writing docs. The Texinfo manual is well indexed, so it's very easy to find how to format each directive. For example, "i xref RET" will immediately land you in the section that describes the @xref directive, which is the main directive for cross-references; the other ones are @pxref and @ref. > I added the documentation about the indicator on the beginning of the > Node because I think it is somehow more general as it is not restricted > to graphical displays like the boundaries indicator. This is OK. > Maybe it is possible to add some division in the page to highlight that > there are at least 2 topics there. (Markdown equivalent to #, ##, ### > and so on) I see no need. The text can clearly indicate where a new sub-topic starts. > I also removed most of the text in NEWS (As I moved it to the > manual). Please give a look if it is better now. Comments: . Use 2 spaces between sentences, per our conventions. . Be sure to remove trailing whitespace (I have show-trailing-whitespace turned on in derivatives of Text mode for that purpose). . Don't use "new" or "old" in the manual -- this is appropriate for NEWS, but the manual describes what Emacs does regardless of when this became available. . The sentence which starts with "Is the" is not correct English. Instead, say something like "Specifies the ...". . nil and t are symbols, so should be in @code. . You have left one symbol quoted 'like this' instead of being in @code. . I spotted one typo: "throw" instead of "through". . For best future-proof results, take long commands in @w{}, as in @w{@kbd{M-x global-display-fill-column-indicator-mode}}, to prevent makeinfo and TeX from breaking them up between 2 lines at the whitespace. There's also a typo in NEWS: "The indicators is not displayed" -- this mixes singular and plural forms. The doc string of display-fill-column-indicator-column has a too-long first sentence, it should fit on a 80-column line. Thanks.