Re: Converting README documentation to Markdown
Peter Eisentraut <peter@eisentraut.org>
From: Peter Eisentraut <peter@eisentraut.org>
To: Daniel Gustafsson <daniel@yesql.se>,
Jelte Fennema-Nio <postgres@jeltef.nl>
Cc: PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2024-12-02T09:02:30Z
Lists: pgsql-hackers
On 01.10.24 22:15, Daniel Gustafsson wrote: >> On 1 Oct 2024, at 16:53, Jelte Fennema-Nio <postgres@jeltef.nl> wrote: >> On Tue, 1 Oct 2024 at 15:52, Daniel Gustafsson <daniel@yesql.se> wrote: > >>>> Apart from this, I don't changing the placeholders like <foo> to < foo >. In some cases, this really decreases readability. Maybe we should look for different approaches there. >>> >>> Agreed. I took a stab at some of them in the attached. The usage in >>> src/test/isolation/README is seemingly the hardest to replace and I'm not sure >>> how we should proceed there. >> >> One way to improve the isolation/README situation is by: >> 1. indenting the standalone lines by four spaces to make it a code block >> 2. for the inline cases, replace <foo> with `<foo>` or `foo` > > If we go for following Markdown syntax then for sure, if not it will seem a bit > off I think. I took another look through this discussion. I think the v4 patches from 2024-10-01 are a good improvement. I suggest you commit them and then we can be done here.