Re: GetExistingLocalJoinPath() vs. the docs

From: Ashutosh Bapat <ashutosh(dot)bapat(at)enterprisedb(dot)com>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: Stephen Frost <sfrost(at)snowman(dot)net>, pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: GetExistingLocalJoinPath() vs. the docs
Date: 2016-03-02 06:12:27
Message-ID: CAFjFpRc-szN5ZtR8YEhuV1z1psbLgjjDOT17MrBPyNqQY9=Z+w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

I think that you need to take a little broader look at this section.
> At the top, it says "To use any of these functions, you need to
> include the header file foreign/foreign.h in your source file", but
> this function is defined in foreign/fdwapi.h. It's not clear to me
> whether we should consider moving the prototype, or just document that
> this function is someplace else. The other functions prototyped in
> fdwapi.h aren't documented at all, except for
> IsImportableForeignTable, which is mentioned in passing.
>
> Further down, the section says "Some object types have name-based
> lookup functions in addition to the OID-based ones:" and you propose
> to put the documentation for this function after that. But this
> comment doesn't actually describe this particular function.
>

> Actually, this function just doesn't seem to fit into this section at
> all. It's really quite different from the others listed there. How
> about something like the attached instead?

Right. Mentioning the function in the description of relevant function
looks better and avoids some duplication.

--
Best Wishes,
Ashutosh Bapat
EnterpriseDB Corporation
The Postgres Database Company

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Michael Paquier 2016-03-02 06:30:53 Re: Publish autovacuum informations
Previous Message Tom Lane 2016-03-02 06:07:33 Re: TAP / recovery-test fs-level backups, psql enhancements etc