From: George Clemmer <myglc2@gmail.com>
To: guix-devel@gnu.org
Subject: Re: Manual consistency
Date: Tue, 09 Jun 2020 16:56:24 -0400 [thread overview]
Message-ID: <85h7vkc613.fsf@gmail.com> (raw)
In-Reply-To: <CAJ3okZ3WfjR3tbgQX-B_WvihZFazvR7AfNquYYXE6+Hp5nOBzw@mail.gmail.com>
zimoun <zimon.toutoune@gmail.com> writes:
> (from: http://issues.guix.gnu.org/issue/41253#10)
>
> On Fri, 5 Jun 2020 at 18:36, Ludovic Courtès <ludo@gnu.org> wrote:
>
>> > There are many examples in guix.texi with $, and also many without. Plus
>> > some with # as the command line prompt.
>> I’ve come to the conclusion that snippets that contain only input should
>> be written without a prompt, for easier copy/pasting.
> I propose to do a pass on that:
> - apply this rule: no-$ for only input and $ to distinguish between
> inputs and outputs.
+1.
For examples w/ outputs, how about also removing the $ and commenting
the outputs with '# ', or '# > '?
HTH - George
prev parent reply other threads:[~2020-06-09 21:04 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-05 17:34 Manual consistency zimoun
2020-06-05 18:02 ` Julien Lepiller
2020-06-05 19:50 ` Ricardo Wurmus
2020-06-09 15:55 ` Ludovic Courtès
2020-06-09 17:13 ` Ricardo Wurmus
2020-06-09 18:12 ` Julien Lepiller
2020-06-10 13:08 ` Ricardo Wurmus
2020-06-10 15:20 ` Ludovic Courtès
2020-06-10 20:23 ` Dmitry Alexandrov
2020-06-11 8:33 ` Ricardo Wurmus
2020-06-11 11:00 ` Julien Lepiller
2020-06-11 18:52 ` Dmitry Alexandrov
2020-06-11 20:53 ` Ricardo Wurmus
2020-06-11 22:58 ` Dmitry Alexandrov
2020-06-05 20:16 ` Ricardo Wurmus
2020-06-09 20:56 ` George Clemmer [this message]
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://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=85h7vkc613.fsf@gmail.com \
--to=myglc2@gmail.com \
--cc=guix-devel@gnu.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.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).