Feedback-ID: ie0a040ee:Fastmail
Message-ID: <b03f24e3-10b7-4b0e-ba82-b56619ee8dc1@eisentraut.org>
Date: Tue, 19 Dec 2023 16:48:14 +0100
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [DOC] Introducing Quick Start Guide to PL/pgSQL and PL/Python
 Documentation
Content-Language: en-US
To: Ishaan Adarsh <ishaanad9@gmail.com>, pgsql-hackers@lists.postgresql.org
References: <CA+oefZ72dLzRzgDe0VU01b7m4+A2bkQnZfXSuvXSzV7QHm0R3Q@mail.gmail.com>
From: Peter Eisentraut <peter@eisentraut.org>
In-Reply-To: <CA+oefZ72dLzRzgDe0VU01b7m4+A2bkQnZfXSuvXSzV7QHm0R3Q@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Archived-At: <https://www.postgresql.org/message-id/b03f24e3-10b7-4b0e-ba82-b56619ee8dc1%40eisentraut.org>
Precedence: bulk

On 16.12.23 11:49, Ishaan Adarsh wrote:
> 1. Added a new section titled "Quick Start Guide" to both PL/pgSQL and 
> PL/Python documentation.
> 2. Included step-by-step instructions for users to get started with 
> these procedural languages.
> 3. Provided explanations, code snippets, and examples to illustrate key 
> concepts.

The way I read it, that's not really what your patch does.  Your patch 
explains how to write an extension in PL/pgSQL and PL/Python, 
respectively.  Which is okay, I guess, but a bit unusual.  But I 
wouldn't call that an unqualified "quick start" in the respective 
languages.  Also, it seems to repeat the very basics of setting up an 
extension file structure etc. repeatedly in each chapter.

The existing documentation has "explanations, code snippets, and 
examples".  Are they not good?  Do you have more?  Better ones?  Why are 
yours separate from the existing ones?

I think it would be useful to take a step back here and define the 
purpose of a bit clearer.