public inbox for [email protected]  
help / color / mirror / Atom feed
From: Daniel Gustafsson <[email protected]>
To: [email protected]
Subject: Improve wording for FDW header file reference
Date: Thu, 18 Oct 2018 11:25:56 +0200
Message-ID: <[email protected]> (raw)

The "Foreign Data Wrapper Callback Routines” section contains an odd wording in
the reference to the relevant headerfile:

	"The FdwRoutine struct type is declared in
	src/include/foreign/fdwapi.h, which see for additional details.”

The attached patch is an attempt at improving this.

cheers ./daniel



Attachments:

  [application/octet-stream] fdwapi_wording.patch (1020B, 2-fdwapi_wording.patch)
  download | inline diff:
From fce56285540ee3b0565b84d6ce93b36c894ddfd5 Mon Sep 17 00:00:00 2001
From: Daniel Gustafsson <[email protected]>
Date: Thu, 18 Oct 2018 10:51:20 +0200
Subject: [PATCH] docs: Improve wording for referring to header file

Commit 21734d2fb896e0ecdddd3251caa72a3576e2d415 introduced an odd
wording for referring to the header file for further details.
---
 doc/src/sgml/fdwhandler.sgml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/src/sgml/fdwhandler.sgml b/doc/src/sgml/fdwhandler.sgml
index 4ce88dd77c..34fa2b3089 100644
--- a/doc/src/sgml/fdwhandler.sgml
+++ b/doc/src/sgml/fdwhandler.sgml
@@ -91,8 +91,8 @@
 
     <para>
      The <structname>FdwRoutine</structname> struct type is declared in
-     <filename>src/include/foreign/fdwapi.h</filename>, which see for additional
-     details.
+     <filename>src/include/foreign/fdwapi.h</filename>, which contains
+     additional details on the struct members.
     </para>
 
    <sect2 id="fdw-callbacks-scan">
-- 
2.14.1.145.gb3622a4ee



reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: Improve wording for FDW header file reference
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox