From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Ergus Newsgroups: gmane.emacs.devel Subject: Re: Fill column indicator functionality Date: Wed, 3 Apr 2019 12:22:36 +0200 Message-ID: <20190403102234.gyk45tfk4uypilhn@Ergus> References: <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> <83sguzekc5.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii; format=flowed Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="9574"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: NeoMutt/20180716 Cc: emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Wed Apr 03 12:23:42 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 1hBd3S-0002Cz-UB for ged-emacs-devel@m.gmane.org; Wed, 03 Apr 2019 12:23:40 +0200 Original-Received: from localhost ([127.0.0.1]:53815 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hBd3E-0006hD-V8 for ged-emacs-devel@m.gmane.org; Wed, 03 Apr 2019 06:23:24 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:38684) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hBd2d-0006gq-Oo for emacs-devel@gnu.org; Wed, 03 Apr 2019 06:22:48 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hBd2c-0004ds-LV for emacs-devel@gnu.org; Wed, 03 Apr 2019 06:22:47 -0400 Original-Received: from sonic309-24.consmr.mail.ir2.yahoo.com ([77.238.179.82]:38610) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hBd2c-0004c9-3N for emacs-devel@gnu.org; Wed, 03 Apr 2019 06:22:46 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=aol.com; s=a2048; t=1554286962; bh=B9C1KkOneN5nFpa2MNjLxLD7FlFa1HnGxc+BbNCSxpA=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From:Subject; b=AlZ5xX67laF4Cxbb74ChwotwB4AKz2LsL+2j+6OMSGeQjlP2Mgw55VDIJqP8Spu5n8seqOQruaG9BeULwuLN+q/oivSFCZa1Q6Y/ohMePEcHnxpm9tTNTUqBgLVWMXOIVEIqIKsMQSTKAkZku1hCAokTkNuXY4l2VLAsF5SryOFareG4v0InvQCB06DteZYzH2cnbG6SWS9crMuOKD04PvKVQc+rt4whSw4/0n6aadgMR7ghd9vXfh2HxMYQTwOH4ve8T+Scifrv9O4sWmYFHrDld7miqLqJmsvhHubieQYtjDJOfcKK3JNQcttjYZ8zm/uyAuHftahSapPc7Vxp8g== X-YMail-OSG: oycHNQgVM1nqdDWnsJE9NYgIPTQBZOZftHi9RP1EWprCt0llmjTlPilZVCZkbdg XSnK0MVEMxlYCovRxH_GW.ywvO3ykmLp5CsggkGfyXHRLqZ1Z7lNBYZ7yr9czt4QTBC_Umc1w7BU lkMsghjrUdnfjg.E4IfyNkFeAbTKPLh.ThtgkoEOKQTZJlofqw_SHw8YHRByEL07EOb4otcNRaXe f8AGnn684ahzGy74ivf98ExJ8d56d2V1OY9mbLHvWdreRlz_HTD368DnI6PkrU2FQ9Uk7f01Hizw Lx1sxzOpaFkSf0X7bShK5Vfq4Ag4sxe2q9k0AizW9XlDBFstkEFGc0UThygHBEuu6aw2LRaPu_Ax jcl3BSw.Uj2eJJhk76DANcztM3dcJd_e_EC5jBiWdOKXcrqNSJgFA_7FVLV4f3Yd8YcAtIe7QeHu qgwyWQIZ2IrWCvhP4R8OrjiOEkOR95Pm.P_MSLRVpEzwncio.xSVtgwSO.uSYAXJ.cSOn95xyfT0 L0zBp9H9MCcrWQw6hG2GldV25f_xL9vvvqjmupp2X70y6XIDmpC3dKCmszZiv38D34RyKXCNV1pT bSb_jQxzHQtLXOe3KmPyPXNxHHpeO6a.301Rd_7RgGHsCweTZcAyxNnET31Pb1_EqjGXWnEKrW4d Zw9.xj.fjKfIci9KpyrZoh1gg5m0NdMD17vJCn4B8NUNtdvvu4EsMt9KTOooFZqVrGdqSxEboypq YIl5ZY5L4pON7.E9J9OMMIcYOkahfX9iDYzcPG5LOLi.lZfMvxTbPLbTcwIK8aig9SwLL9RB1Lf0 nSPu2Akk.TZrhgfrCCEujLi6rUxrefRnlfw21hXSxo Original-Received: from sonic.gate.mail.ne1.yahoo.com by sonic309.consmr.mail.ir2.yahoo.com with HTTP; Wed, 3 Apr 2019 10:22:42 +0000 Original-Received: from 84.88.50.33 (EHLO Ergus) ([84.88.50.33]) by smtp406.mail.ir2.yahoo.com (Oath Hermes SMTP Server) with ESMTPA ID b6f7fda72699ec6b53b73f154722be92; Wed, 03 Apr 2019 10:22:39 +0000 (UTC) Content-Disposition: inline In-Reply-To: <83sguzekc5.fsf@gnu.org> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 77.238.179.82 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:234917 Archived-At: I just pushed a commit with your corrections to the manual. Hope it is better now. I tried to do a rebase of the branch (to keep it synchronized with master) and I see it was not possible to rebase the public branch. I am wondering that at the end I will need to do a rebase and the squash locally and a merge in master in a different patch if I want to keep a nice history... Now I see the advantages of having forks and pull/merge requests. This makes me reconsider the importance of the gitlab discussion from some days ago. On Wed, Apr 03, 2019 at 08:20:10AM +0300, Eli Zaretskii wrote: >> 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.