unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
* Manual consistency
@ 2020-06-05 17:34 zimoun
  2020-06-05 18:02 ` Julien Lepiller
  2020-06-09 20:56 ` George Clemmer
  0 siblings, 2 replies; 16+ messages in thread
From: zimoun @ 2020-06-05 17:34 UTC (permalink / raw)
  To: Ludovic Courtès, Konrad Hinsen, Guix Devel

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


^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, other threads:[~2020-06-11 22:59 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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

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).