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.1907121748290.8895@lancre
Whole thread Raw
In response to Re: SPITupleTable members missing in docs  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-docs
Hello,

>> To take into account Tom's comment, I'd suggest a middle ground by 
>> commenting a public and private part explicitely in the struct,
>>    typedef struct {
>>      /* PUBLIC members to be used by callers ... */
>>      /* PRIVATE members, not intended for external usage ... */
>>    } ... ;
>
> One problem is that the members we've retroactively decided are "public"
> are in the middle of the struct :-(.

Argh, I did not notice this tiny but relevant detail.

> But it occurs to me that there's no good reason we couldn't re-order the
> members, as long as we only do so on HEAD and not in released versions.
> That would make it a bit less inconsistent and easier to add labels
> such as you suggest.

Indeed. SPI-dependent extensions are likely recompiled between major 
version, so a reordering should not cause significant problems.

This mean that a simple doc patch is turned into a code patch.

-- 
Fabien.



pgsql-docs by date:

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