public inbox for [email protected]  

help / color / mirror / Atom feed

Minor doc correction for SPI_execute_with_args
2+ messages / 2 participants
[nested] [flat]

* Minor doc correction for SPI_execute_with_args
@ 2015-05-29 08:01 Ian Barwick <[email protected]>
  2015-05-30 17:57 ` Re: Minor doc correction for SPI_execute_with_args Tom Lane <[email protected]>
  0 siblings, 1 reply; 2+ messages in thread

From: Ian Barwick @ 2015-05-29 08:01 UTC (permalink / raw)
  To: pgsql-docs

Hi

The documentation for SPI_execute_with_args:

  http://www.postgresql.org/docs/current/static/spi-spi-execute-with-args.html

claims it returns the same value as SPI_execute, whereas it actually
calls SPI_execute_plan which can produce two additional error codes.


Regards

Ian Barwick

-- 
 Ian Barwick                   http://www.2ndQuadrant.com/
 PostgreSQL Development, 24x7 Support, Training & Services


-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs


Attachments:

  [text/x-patch] doc-spi-execute-with-args.patch (549B, 2-doc-spi-execute-with-args.patch)
  download | inline diff:
diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml
new file mode 100644
index c099fcf..108e160
*** a/doc/src/sgml/spi.sgml
--- b/doc/src/sgml/spi.sgml
*************** int SPI_execute_with_args(const char *<p
*** 842,848 ****
    <title>Return Value</title>
  
    <para>
!    The return value is the same as for <function>SPI_execute</function>.
    </para>
  
    <para>
--- 842,848 ----
    <title>Return Value</title>
  
    <para>
!    The return value is the same as for <function>SPI_execute_plan</function>.
    </para>
  
    <para>


^ permalink  raw  reply  [nested|flat] 2+ messages in thread

* Re: Minor doc correction for SPI_execute_with_args
  2015-05-29 08:01 Minor doc correction for SPI_execute_with_args Ian Barwick <[email protected]>
@ 2015-05-30 17:57 ` Tom Lane <[email protected]>
  0 siblings, 0 replies; 2+ messages in thread

From: Tom Lane @ 2015-05-30 17:57 UTC (permalink / raw)
  To: Ian Barwick <[email protected]>; +Cc: pgsql-docs

Ian Barwick <[email protected]> writes:
> The documentation for SPI_execute_with_args:
>   http://www.postgresql.org/docs/current/static/spi-spi-execute-with-args.html
> claims it returns the same value as SPI_execute, whereas it actually
> calls SPI_execute_plan which can produce two additional error codes.

But SPI_execute also calls _SPI_execute_plan.  Moreover, the documented
reasons for SPI_execute_plan to return additional error codes don't match
up too closely with SPI_execute_with_args (eg, there's no "plan"
argument, so saying "plan was prepared with some parameters" is pretty
meaningless here).

If what you're looking at is the extra error conditions right at the start
of SPI_execute_with_args, my inclination would be to document them without
any reference to SPI_execute_plan, ie we'd add text much like what's
under SPI_execute_plan but with the descriptions of the error codes
adjusted to agree with this function.

			regards, tom lane


-- 
Sent via pgsql-docs mailing list ([email protected])
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs




^ permalink  raw  reply  [nested|flat] 2+ messages in thread

end of thread, other threads:[~2015-05-30 17:57 UTC | newest]

Thread overview: 2+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2015-05-29 08:01 Minor doc correction for SPI_execute_with_args Ian Barwick <[email protected]>
2015-05-30 17:57 ` Tom Lane <[email protected]>

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