Re: Contribution to Perldoc for TestLib module in Postgres

From: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>
To: Michael Paquier <michael(at)paquier(dot)xyz>
Cc: Andrew Dunstan <andrew(dot)dunstan(at)2ndquadrant(dot)com>, "Iwata, Aya" <iwata(dot)aya(at)jp(dot)fujitsu(dot)com>, 'Ramanarayana' <raam(dot)soft(at)gmail(dot)com>, Prajwal A V <prajwal450(at)gmail(dot)com>, PostgreSQL mailing lists <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Contribution to Perldoc for TestLib module in Postgres
Date: 2019-09-02 17:48:14
Message-ID: 20190902174814.GA25471@alvherre.pgsql
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-hackers

On 2019-Jul-30, Michael Paquier wrote:

> I think that the SYNOPSIS could be shaped better. As of now it is a
> simple succession of the same commands listed without any link to each
> other, which is contrary for example to what we do in,
> where it shows up a set of small examples which are useful to
> understand how to shape the tests and the possible interactions
> between the routines of the module. My take would be to keep it
> simple and minimal as is the lowest level of our TAP test
> infrastructure.

Agreed ... that's pretty much the same thing I tried to say upthread. I
wrote my own synopsis, partly using your suggestions. I reworded the
description for the routines (I don't think there's any I didn't touch),
added a mention of $windows_os, added a =head1 to split out the ad-hoc
routines from the Test::More wrappers.

And pushed.

Please give it another look. It might need more polish.

Álvaro Herrera
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

In response to


Browse pgsql-hackers by date

  From Date Subject
Next Message Alvaro Herrera 2019-09-02 17:54:15 Re: Proposal for Signal Detection Refactoring
Previous Message Andrey Borodin 2019-09-02 17:37:23 Re: PG 12 draft release notes