From: Kyle Meyer <kyle@kyleam.com> To: meta@public-inbox.org Subject: [PATCH 4/8] doc lei: don't render most to-do comments Date: Sun, 28 Mar 2021 23:11:13 -0400 [thread overview] Message-ID: <20210329031117.28516-5-kyle@kyleam.com> (raw) In-Reply-To: <20210329031117.28516-1-kyle@kyleam.com> The lei manpages have a number of to-dos, but with the exception of the lei-q's -tt warning, none of them seem worth displaying to the reader (and some might not be worth addressing at all). --- Documentation/lei-add-external.pod | 1 + Documentation/lei-q.pod | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod index 3bc0ba83..47158146 100644 --- a/Documentation/lei-add-external.pod +++ b/Documentation/lei-add-external.pod @@ -15,6 +15,7 @@ C<extindex.<name>.topdir> value in ~/.public-inbox/config. =head1 OPTIONS +=for comment TODO: mention curl options? =over diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index cb1227fb..6f67c277 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -12,10 +12,12 @@ lei q [OPTIONS] (--stdin|-) Search for messages across the lei store and externals. +=for comment TODO: Give common prefixes, or at least a description/reference. =head1 OPTIONS +=for comment TODO: mention curl options? =over @@ -40,6 +42,7 @@ the destination. C<json> is used for the default destination (stdout), and C<maildir> is used for an existing directory or non-existing path. +=for comment TODO: Provide description of formats? Default: - @@ -98,6 +101,7 @@ C<none>. Default: C<content> +=for comment TODO: Provide description of strategies? =item --[no-]remote -- 2.31.0
next prev parent reply other threads:[~2021-03-29 3:12 UTC|newest] Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-03-29 3:11 [PATCH 0/8] doc: lei manpages, round 4 Kyle Meyer 2021-03-29 3:11 ` [PATCH 1/8] doc lei-q: fix typo in -tt description Kyle Meyer 2021-03-29 3:11 ` [PATCH 2/8] doc lei: note --stdin shortcut in synopses Kyle Meyer 2021-03-29 3:11 ` [PATCH 3/8] doc lei: drop an unnecessary to-do comment Kyle Meyer 2021-03-29 3:11 ` Kyle Meyer [this message] 2021-03-29 3:11 ` [PATCH 5/8] doc lei: update manpages with new options Kyle Meyer 2021-03-29 3:11 ` [PATCH 6/8] doc lei: add manpages for new commands Kyle Meyer 2021-03-29 3:25 ` Eric Wong 2021-03-29 3:35 ` Kyle Meyer 2021-03-29 3:11 ` [PATCH 7/8] doc lei overview: note that lei-init is usually unnecessary Kyle Meyer 2021-03-29 3:11 ` [PATCH 8/8] doc lei overview: better explain routes into local store Kyle Meyer 2021-03-29 3:18 ` [PATCH 0/8] doc: lei manpages, round 4 Eric Wong
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style List information: https://public-inbox.org/README * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210329031117.28516-5-kyle@kyleam.com \ --to=kyle@kyleam.com \ --cc=meta@public-inbox.org \ --subject='Re: [PATCH 4/8] doc lei: don'\''t render most to-do comments' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://80x24.org/public-inbox.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).