From: | "Iwata, Aya" <iwata(dot)aya(at)jp(dot)fujitsu(dot)com> |
---|---|
To: | 'Ramanarayana' <raam(dot)soft(at)gmail(dot)com> |
Cc: | Prajwal A V <prajwal450(at)gmail(dot)com>, Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, PostgreSQL mailing lists <pgsql-hackers(at)postgresql(dot)org>, Michael Paquier <michael(at)paquier(dot)xyz> |
Subject: | RE: Contribution to Perldoc for TestLib module in Postgres |
Date: | 2019-04-11 02:10:24 |
Message-ID: | 71E660EB361DF14299875B198D4CE5423DF17147@g01jpexmbkw25 |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-hackers |
Hi Ram,
I think this documentation helps people who want to understand functions.
>Please find the updated patch. Added to the commitfest as well
I have some comments.
I think some users who would like to know custom function check src/test/perl/README at first.
How about add comments to the README file, such as "See Testlib.pm if you want to know more details"?
In the above document, why not write a description after the function name?
I think it is better to write the function name first and then the description.
In your code;
#Checks if all the tests passed or not
all_tests_passing()
In my suggestion;
all_tests_passing()
Checks if all the tests passed or not
And some functions return value. How about adding return information to the above doc?
I find ^M character in your new code. Please use LF line ending not CRLF or get rid of it in next patch.
Regards,
Aya Iwata
From | Date | Subject | |
---|---|---|---|
Next Message | David Rowley | 2019-04-11 03:34:30 | Re: Should we add GUCs to allow partition pruning to be disabled? |
Previous Message | David Rowley | 2019-04-11 01:49:06 | Re: Should the docs have a warning about pg_stat_reset()? |