| From: | Jelte Fennema-Nio <postgres(at)jeltef(dot)nl> |
|---|---|
| To: | Peter Eisentraut <peter(at)eisentraut(dot)org> |
| Cc: | Daniel Gustafsson <daniel(at)yesql(dot)se>, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org> |
| Subject: | Re: Converting README documentation to Markdown |
| Date: | 2024-06-28 09:56:43 |
| Message-ID: | CAGECzQTaR-Bbr010GiuGRi3L0-1gdGwG6XsfWkKC-AZn4hf_yQ@mail.gmail.com |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
On Fri, 28 Jun 2024 at 09:38, Peter Eisentraut <peter(at)eisentraut(dot)org> wrote:
> Getting that right in Markdown can be quite tricky.
I agree that in some cases it's tricky. But what's the worst case that
can happen when you get it wrong? It renders weird on github.com.
Luckily there's a "code" button to go to the plain text format[1]. In
all other cases (which I expect will be most) the doc will be easier
to read. Forcing plaintext, just because sometimes we might make a
mistake in the syntax seems like an overcorrection imho. Especially
because these docs are (hopefully) read more often than written.
[1]: https://github.com/postgres/postgres/blob/master/README.md?plain=1
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Robins Tharakan | 2024-06-28 10:20:08 | Re: recoveryCheck/008_fsm_truncation is failing on dodo in v14- (due to slow fsync?) |
| Previous Message | Amit Kapila | 2024-06-28 09:45:22 | Re: walsender.c comment with no context is hard to understand |