From: Jon Turney <jon.turney@dronecode.org.uk>
To: "cygwin-apps@cygwin.com" <cygwin-apps@cygwin.com>
Subject: newlines in ldesc
Date: Wed, 31 Jan 2024 20:38:17 +0000 [thread overview]
Message-ID: <35502417-5863-4d1c-bc07-c69ba99dee3d@dronecode.org.uk> (raw)
We now have a few places where the long description (ldesc) for a
package is used (in the package summary webpage, in the tooltip for the
package description in setup, and now in any automatically generated
announce email).
Unfortunately, it's underspecified exactly what a newline in ldesc
means, and taking it literally causes problems when trying to render it
nicely in those places. (Some heuristic hacks are already applied to it
in the package summary webpage to try to make things look reasonable)
Therefore, I'm proposing to define that the following very minimal
subset of MarkDown-compatible markup can be used in ldesc:
* A blank line separates paragraphs
* A line ending with two (or more spaces) is followed by a line break
* Lines starting with '-', '*', or '+' are bulleted lists
- Sublists are indented by four spaces
(Technically, all of this also applies to the message: hint, being the
only other hint which can take a multi-line value, but since that's only
used by one package currently, that's not much of a concern)
reply other threads:[~2024-01-31 20:38 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=35502417-5863-4d1c-bc07-c69ba99dee3d@dronecode.org.uk \
--to=jon.turney@dronecode.org.uk \
--cc=cygwin-apps@cygwin.com \
/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.
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).