RE: Contribution to Perldoc for TestLib module in Postgres - Mailing list pgsql-hackers

From Iwata, Aya
Subject RE: Contribution to Perldoc for TestLib module in Postgres
Date
Msg-id 71E660EB361DF14299875B198D4CE5423DF17147@g01jpexmbkw25
Whole thread Raw
In response to Re: Contribution to Perldoc for TestLib module in Postgres  (Ramanarayana <raam.soft@gmail.com>)
Responses Re: Contribution to Perldoc for TestLib module in Postgres
List 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

pgsql-hackers by date:

Previous
From: David Rowley
Date:
Subject: Re: Should the docs have a warning about pg_stat_reset()?
Next
From: David Rowley
Date:
Subject: Re: Should we add GUCs to allow partition pruning to be disabled?