all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: zimoun <zimon.toutoune@gmail.com>
To: "Ludovic Courtès" <ludo@gnu.org>,
	"Konrad Hinsen" <konrad.hinsen@fastmail.net>,
	"Guix Devel" <guix-devel@gnu.org>
Subject: Manual consistency
Date: Fri, 5 Jun 2020 19:34:57 +0200	[thread overview]
Message-ID: <CAJ3okZ3WfjR3tbgQX-B_WvihZFazvR7AfNquYYXE6+Hp5nOBzw@mail.gmail.com> (raw)

Hi Ludo,

(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.
>
> Yeah, the manual is kinda inconsistent, and I’m self-inconsistent to
> tell the truth.  :-)
>
> I’ve come to the conclusion that snippets that contain only input should
> be written without a prompt, for easier copy/pasting.
>
> (I’ve seen Python documentation where JS magic allows people to toggle
> prompt display, I find it nice.)

I propose to do a pass on that:
 - apply this rule: no-$ for only input and $ to distinguish between
inputs and outputs.
 - backtick ` replaced by $(...) as discussed elsewhere
and then send a "Fix typo" patch.  And maybe add a bullet in the
Contributing Section.

WDYT?

All the best,
simon


             reply	other threads:[~2020-06-05 17:35 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-05 17:34 zimoun [this message]
2020-06-05 18:02 ` Manual consistency 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

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAJ3okZ3WfjR3tbgQX-B_WvihZFazvR7AfNquYYXE6+Hp5nOBzw@mail.gmail.com \
    --to=zimon.toutoune@gmail.com \
    --cc=guix-devel@gnu.org \
    --cc=konrad.hinsen@fastmail.net \
    --cc=ludo@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 external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.