Add docs clarifying that FieldDescriptions may return nil

https://github.com/jackc/pgx/issues/1634
2023-06-14 07:42:11 -05:00
parent c542df4fb4
commit 5f28621394
3 changed files with 10 additions and 2 deletions
@@ -1479,7 +1479,8 @@ func (rr *ResultReader) NextRow() bool {
 }

 // FieldDescriptions returns the field descriptions for the current result set. The returned slice is only valid until
-// the ResultReader is closed.
+// the ResultReader is closed. It may return nil (for example, if the query did not return a result set or an error was
+// encountered.)
 func (rr *ResultReader) FieldDescriptions() []FieldDescription {
 	return rr.fieldDescriptions
 }