Re: SPITupleTable members missing in docs - Mailing list pgsql-docs

From Fabien COELHO
Subject Re: SPITupleTable members missing in docs
Date
Msg-id alpine.DEB.2.21.1907121649180.8895@lancre
Whole thread Raw
In response to SPITupleTable members missing in docs  (Daniel Gustafsson <daniel@yesql.se>)
Responses Re: SPITupleTable members missing in docs
List pgsql-docs
Hello Daniel,

> Since this makes the number of internal members far outnumber the public 
> ones, also reword the statement about which fields can be used to try 
> and improve clarity.

Patch applies cleanly, doc build ok.

To take into account Tom's comment, I'd suggest a middle ground by 
commenting a public and private part explicitely in the struct, something 
like:

   typedef struct {
     /* PUBLIC members to be used by callers ... */
     ...
     ...
     /* PRIVATE members, not intended for external usage ... */
     ...
   } ... ;

Another option would be to use some python-like naming convention on such 
members, eg with a leading underline character.

Even if it is redundant with the paragraph below, it would make things 
visually clear as well.

Note: I'm probaly not a member of the pgdoc list, so the delivery may fail 
there.

-- 
Fabien.



pgsql-docs by date:

Previous
From: Liudmila Mantrova
Date:
Subject: Re: misc doc fixes for REL_12_STABLE
Next
From: Tom Lane
Date:
Subject: Re: SPITupleTable members missing in docs