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

From Daniel Gustafsson
Subject Re: Converting README documentation to Markdown
Date
Msg-id 40BD1E21-AF8B-4414-B4DF-D4DC62CAD3D2@yesql.se
Whole thread Raw
In response to Re: Converting README documentation to Markdown  (Jelte Fennema-Nio <postgres@jeltef.nl>)
List 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




pgsql-hackers by date:

Previous
From: Masahiko Sawada
Date:
Subject: Re: Using per-transaction memory contexts for storing decoded tuples
Next
From: Tom Lane
Date:
Subject: Re: Fixing backslash dot for COPY FROM...CSV