wwwtext: config comment improvements

Use the full URL of the inbox being mirrored to reduce ambiguity
(instead of just the inbox name).

Using asymmetric quotes (e.g `foo') improves readability for me
in that it's more obvious when a quote begins and ends.  It also
lights up fewer pixels and reduces visual noise compared to
double-quotes.

We'll also reflow the `mainrepo' vs `inboxdir' comment slightly
to emphasize the word `instead'.

diff --git a/lib/PublicInbox/WwwText.pm b/lib/PublicInbox/WwwText.pm
index 87dc0751fb6b13fb97611cc3314f836757ec7115..2ed7d0d2ee09d8ba2d4c28282de08bdde9503430 100644 (file)
--- a/lib/PublicInbox/WwwText.pm
+++ b/lib/PublicInbox/WwwText.pm
@@ -139,14 +139,16 @@ sub inbox_config ($$$) {
        push @$hdr, 'Content-Disposition', 'inline; filename=inbox.config';
        my $name = dq_escape($ibx->{name});
        my $inboxdir = '/path/to/top-level-inbox';
+       my $base_url = $ibx->base_url($ctx->{env});
        $$txt .= <<EOS;
-; example public-inbox config snippet for "$name"
-; see public-inbox-config(5) manpage for more details:
+; Example public-inbox config snippet for a mirror of
+; $base_url
+; See public-inbox-config(5) manpage for more details:
 ; https://public-inbox.org/public-inbox-config.html
 [publicinbox "$name"]
        inboxdir = $inboxdir
-       ; note: public-inbox before v1.2.0 used "mainrepo"
-       ; instead of "inboxdir", both remain supported after 1.2
+       ; note: public-inbox before v1.2.0 used `mainrepo' instead of
+       ; `inboxdir', both remain supported after 1.2
        mainrepo = $inboxdir
        url = https://example.com/$name/
        url = http://example.onion/$name/
@@ -156,7 +158,6 @@ EOS
                $$txt .= "\t$k = $_\n" for @$v;
        }
        if (my $altid = $ibx->{altid}) {
-               my $base_url = $ibx->base_url($ctx->{env});
                my $altid_map = $ibx->altid_map;
                $$txt .= <<EOF;
        ; altid DBs may be used to provide numeric article ID lookup from