unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Cook, Malcolm" <MEC@stowers.org>
To: "'Ludovic Courtès'" <ludo@gnu.org>, "Alex Kost" <alezost@gmail.com>
Cc: "guix-devel@gnu.org" <guix-devel@gnu.org>
Subject: RE: Formatting lists in descriptions
Date: Tue, 14 Jul 2015 18:58:14 +0000	[thread overview]
Message-ID: <78a9e9745e3448c0aaaea5a54de59fe9@exchsrv2.sgc.loc> (raw)
In-Reply-To: <874ml6swik.fsf@gnu.org>

> Yes, why not; it’s still not very pleasant to the eye but at least it formatting
> will be preserved (except for guix-web, but we can fix it
> later.)
> 
> > And as I have an unhealthy desire to organize the same things in the
> > same manner, what variant to choose for formatting lists?  Should the
> > list items begin with "-" or "+" or "*" or "•" and should there be
> > spaces before the chosen symbol or maybe there should be just a couple
> > of spaces without any marker?
> 
> I have a slight preference for • (which is the standard thing in English, AIUI),
> preceded by two spaces.
> 
> The downside is that it won’t render properly on non-Unicode capable
> terminals (and in a non-Unicode-capable locale, Guile will emit a question
> mark instead), but I think that’s a price I don’t mind paying.


Hi - I'm late to this discussion - not sure all the issues on the table - but how about deferring to markdown in such cases.

In which case use "#" and "##" for section headers and 

"Unordered lists use asterisks, pluses, and hyphens — interchangably — as list markers"

Personally, I don't like asterisk ' * ' since they are used by emacs org-mode for headlines (albeit without leading space).

~Malcolm


> 
> Thoughts?
> 
> Thanks,
> Ludo’.


  reply	other threads:[~2015-07-14 18:58 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-07-12 17:41 [PATCH] gnu: Document xorg packages Alex Kost
2015-07-13 17:06 ` Ludovic Courtès
2015-07-14  8:32   ` Formatting lists in descriptions (was: [PATCH] gnu: Document xorg packages.) Alex Kost
2015-07-14 13:23     ` Formatting lists in descriptions Ludovic Courtès
2015-07-14 18:58       ` Cook, Malcolm [this message]
2015-07-15 14:28         ` Ludovic Courtès
2015-07-15 15:01           ` Alex Kost

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=78a9e9745e3448c0aaaea5a54de59fe9@exchsrv2.sgc.loc \
    --to=mec@stowers.org \
    --cc=alezost@gmail.com \
    --cc=guix-devel@gnu.org \
    --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 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).