Re: Converting README documentation to Markdown - Mailing list pgsql-hackers

From Peter Eisentraut
Subject Re: Converting README documentation to Markdown
Date
Msg-id c69eb6e7-52c5-414e-a92a-f179ae128afe@eisentraut.org
Whole thread Raw
In response to Re: Converting README documentation to Markdown  (Jelte Fennema-Nio <postgres@jeltef.nl>)
Responses Re: Converting README documentation to Markdown  (Jelte Fennema-Nio <postgres@jeltef.nl>)
List pgsql-hackers
On 28.06.24 11:56, Jelte Fennema-Nio wrote:
> On Fri, 28 Jun 2024 at 09:38, Peter Eisentraut <peter@eisentraut.org> wrote:
>> Getting that right in Markdown can be quite tricky.
> 
> I agree that in some cases it's tricky. But what's the worst case that
> can happen when you get it wrong? It renders weird on github.com.

I have my "less" set up so that "less somefile.md" automatically renders 
the markdown.  That's been pretty useful.  But if that now keeps making 
a mess out of PostgreSQL's README files, then I'm going to have to keep 
fixing things, and I might get really mad.  That's the worst that could 
happen. ;-)

So I don't agree with "aspirational markdown".  If we're going to do it, 
then I expect that the files are marked up correctly at all times.

Conversely, what's the best that could happen?




pgsql-hackers by date:

Previous
From: Peter Geoghegan
Date:
Subject: Re: Improve EXPLAIN output for multicolumn B-Tree Index
Next
From: "Imseih (AWS), Sami"
Date:
Subject: Restart pg_usleep when interrupted