Date: Wed, 10 Feb 2021 14:57:34 +0100 From: Andreas B <panden@gmail.com> To: doc@freebsd.org Subject: Re: Regarding AsciiDoctor and long lines Message-ID: <CAL2%2B-iWpZQi-x4cMLqCMuMH22REirEChP6__m%2B5gd_ZRBwqvGg@mail.gmail.com> In-Reply-To: <20210210135028.u2mm3bhwgep557vu@nerd-thinkpad.local> References: <20210210135028.u2mm3bhwgep557vu@nerd-thinkpad.local>
next in thread | previous in thread | raw e-mail | index | archive | help
Have you considered one sentence per line? Ref. https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line. Andreas On Wed, Feb 10, 2021 at 2:50 PM Daniel Ebdrup Jensen <debdrup@freebsd.org> wrote: > > Hi folks, > > Pursuant to a conversation that was had on #bsddocs on EFnet, this is > mostly me wondering if we can adopt a new standard practice. > > Since the AsciiDoctor conversion, it's become evident that reading diffs > which exceed the usual 72 columns that FreeBSD has standardized on for > style(9) is less than great, especially as some of the sentences in the > documentation can be rather long. > > So I would love if it we can agree to wrap/justify lines to 72 columns, > going forward whenever we touch files. > > I've already started doing this on the handbook/x11 chapter update that > I'm working on, and it's in line with what we're used to from DocBook, > so I don't think it's too much of a big ask? :) > > We also need to decide about it relatively soon, since the Weblate > project needs to know about about it, as it involves their use of .so > files (although the details somewhat escaped me when I read it after > staying up all night, so perhaps a domain expert can fill in the blanks > here?). > > For reference, my testing had led me to believe that AsciiDoctor doesn't > care one bit how it's styled, as long as the actual markup is kept the > same. > > I'm open to feedback about it, of course, but it seems like a very > sensible change to me. > > Yours hopefully, > Daniel Ebdrup Jensen
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAL2%2B-iWpZQi-x4cMLqCMuMH22REirEChP6__m%2B5gd_ZRBwqvGg>