Re: Converting README documentation to Markdown

From: Peter Eisentraut <peter(at)eisentraut(dot)org>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>, Jelte Fennema-Nio <postgres(at)jeltef(dot)nl>
Cc: PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Converting README documentation to Markdown
Date: 2024-12-02 09:02:30
Message-ID: 48c0d838-22ce-4a86-be1f-ef1ecc56afe5@eisentraut.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 01.10.24 22:15, Daniel Gustafsson wrote:
>> 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.

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.

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2024-12-02 09:09:59 Re: Support POSITION with nondeterministic collations
Previous Message Amit Kapila 2024-12-02 08:56:07 Re: Virtual generated columns