* [PATCH 4/8] doc lei: don't render most to-do comments
2021-03-29 3:11 6% [PATCH 0/8] doc: lei manpages, round 4 Kyle Meyer
@ 2021-03-29 3:11 7% ` Kyle Meyer
0 siblings, 0 replies; 2+ results
From: Kyle Meyer @ 2021-03-29 3:11 UTC (permalink / raw)
To: meta
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
^ permalink raw reply related [relevance 7%]
* [PATCH 0/8] doc: lei manpages, round 4
@ 2021-03-29 3:11 6% Kyle Meyer
2021-03-29 3:11 7% ` [PATCH 4/8] doc lei: don't render most to-do comments Kyle Meyer
0 siblings, 1 reply; 2+ results
From: Kyle Meyer @ 2021-03-29 3:11 UTC (permalink / raw)
To: meta
This series updates the lei manpages, continuing from
<20210227180328.28057-1-kyle@kyleam.com>. It covers changes up to the
current tip of master (c9ff20cbef45d32e..80f4192574065106).
[1/8] doc lei-q: fix typo in -tt description
[2/8] doc lei: note --stdin shortcut in synopses
[3/8] doc lei: drop an unnecessary to-do comment
[4/8] doc lei: don't render most to-do comments
[5/8] doc lei: update manpages with new options
[6/8] doc lei: add manpages for new commands
[7/8] doc lei overview: note that lei-init is usually unnecessary
[8/8] doc lei overview: better explain routes into local store
Documentation/lei-add-external.pod | 1 +
Documentation/lei-blob.pod | 109 +++++++++++++++++++++++++++++
Documentation/lei-import.pod | 2 +-
Documentation/lei-ls-label.pod | 43 ++++++++++++
Documentation/lei-mark.pod | 58 +++++++++++++++
Documentation/lei-overview.pod | 32 ++++++++-
Documentation/lei-p2q.pod | 79 +++++++++++++++++++++
Documentation/lei-q.pod | 13 +++-
Documentation/lei.pod | 14 +++-
Documentation/txt2pre | 4 ++
MANIFEST | 4 ++
Makefile.PL | 5 +-
12 files changed, 355 insertions(+), 9 deletions(-)
create mode 100644 Documentation/lei-blob.pod
create mode 100644 Documentation/lei-ls-label.pod
create mode 100644 Documentation/lei-mark.pod
create mode 100644 Documentation/lei-p2q.pod
base-commit: 80f4192574065106ae72a7a73ee0f02ebd86708a
--
2.31.0
^ permalink raw reply [relevance 6%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-03-29 3:11 6% [PATCH 0/8] doc: lei manpages, round 4 Kyle Meyer
2021-03-29 3:11 7% ` [PATCH 4/8] doc lei: don't render most to-do comments Kyle Meyer
Code repositories for project(s) associated with this public 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).