Re: Converting README documentation to Markdown

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: Jelte Fennema-Nio <postgres(at)jeltef(dot)nl>
Cc: Peter Eisentraut <peter(at)eisentraut(dot)org>, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Converting README documentation to Markdown
Date: 2024-10-01 20:15:08
Message-ID: 40BD1E21-AF8B-4414-B4DF-D4DC62CAD3D2@yesql.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

> On 1 Oct 2024, at 16:53, Jelte Fennema-Nio <postgres(at)jeltef(dot)nl> wrote:
> On Tue, 1 Oct 2024 at 15:52, Daniel Gustafsson <daniel(at)yesql(dot)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

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2024-10-01 20:17:19 Re: Fixing backslash dot for COPY FROM...CSV
Previous Message Alvaro Herrera 2024-10-01 20:12:45 Re: not null constraints, again