Fix comment of PQputCopyEnd()

michaelpq · michaelpq · commit 8bf7db0285df · 2023-08-30T08:29:08.000+09:00
The comment describing the error codes of this routine mentioned 0 as a possible value, but this error code has never been used. Author: Junwang Zhao Reviewed-by: Aleksander Alekseev Discussion: https://postgr.es/m/CAEG8a3Jt5KwMNr+_S6VN68rog4HeoG6ELvPQO8kZNQTeJeQ=rQ@mail.gmail.com
diff --git a/src/interfaces/libpq/fe-exec.c b/src/interfaces/libpq/fe-exec.c
@@ -2709,8 +2709,7 @@ PQputCopyData(PGconn *conn, const char *buffer, int nbytes)
  *
  * After calling this, use PQgetResult() to check command completion status.
  *
- * Returns 1 if successful, 0 if data could not be sent (only possible
- * in nonblock mode), or -1 if an error occurs.
+ * Returns 1 if successful, or -1 if an error occurs.
  */
 int
 PQputCopyEnd(PGconn *conn, const char *errormsg)

Original file line number	Diff line number	Diff line change
`@@ -2709,8 +2709,7 @@ PQputCopyData(PGconn conn, const char buffer, int nbytes)`
`2709`	`2709`	`*`
`2710`	`2710`	`* After calling this, use PQgetResult() to check command completion status.`
`2711`	`2711`	`*`
`2712`		`- * Returns 1 if successful, 0 if data could not be sent (only possible`
`2713`		`- * in nonblock mode), or -1 if an error occurs.`
	`2712`	`+ * Returns 1 if successful, or -1 if an error occurs.`
`2714`	`2713`	`*/`
`2715`	`2714`	`int`
`2716`	`2715`	`PQputCopyEnd(PGconn conn, const char errormsg)`