From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,AWL,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 7753B1F5AE; Thu, 29 Apr 2021 01:57:38 +0000 (UTC) Date: Thu, 29 Apr 2021 01:57:38 +0000 From: Eric Wong To: Kyle Meyer Cc: meta@public-inbox.org Subject: Re: [PATCH 2/3] doc: lei q: split =item aliases onto separate lines Message-ID: <20210429015738.GA30172@dcvr> References: <20210428045107.9699-1-e@80x24.org> <20210428045107.9699-3-e@80x24.org> <87o8dxg97w.fsf@kyleam.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <87o8dxg97w.fsf@kyleam.com> List-Id: Kyle Meyer wrote: > Eric Wong writes: > > > It makes L look nicer without resorting to > > L<--augment|/-a, --augment> and similarly verbose nastiness. > > > > Having each option as a separate =item (with a blank line in > > between each =item) seems to be the preferred style used within > > Perl core documentation (I used perlrun.pod as an example), > > so we'll follow Perl core style, here. > > Okay, thanks providing a rationale for using separate lines. I went > with the single line style based on some combination of a subjective > visual preference and looking at other manpages (presumably git's). Yeah, also the existing public-inbox-* manpages were using commas or slash; probably because I based them on git manpages :x > > This needs to be done for other manpages, at some point... > > I should be able to get to another round of lei doc updates this > weekend. Thanks in advance. Also, in response to https://public-inbox.org/meta/20210227180328.28057-1-kyle@kyleam.com/ w.r.t. lei-convert; I think it's helpful to document since the WWW interface provides gzipped mboxrd and IMAP|Maildir are probably the most commonly used.