Re: Converting README documentation to Markdown
Daniel Gustafsson <daniel@yesql.se>
From: Daniel Gustafsson <daniel@yesql.se>
To: Jelte Fennema-Nio <postgres@jeltef.nl>
Cc: Peter Eisentraut <peter@eisentraut.org>,
PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2024-10-01T20:15:08Z
Lists: pgsql-hackers
> 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. -- Daniel Gustafsson