Skip to content

Commit

Permalink
Minor change of wording in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Cito committed Jun 21, 2020
1 parent f240d5f commit f3d57a4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/contents/pg/large_objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ all the recurring variables (object OID and connection), in the same way
:class:`Connection` instances do, thus only keeping significant parameters
in function calls. The :class:`LargeObject` instance keeps a reference to
the :class:`Connection` object used for its creation, sending requests
though with its parameters. Any modification other than dereferencing the
through with its parameters. Any modification other than dereferencing the
:class:`Connection` object will thus affect the :class:`LargeObject` instance.
Dereferencing the initial :class:`Connection` object is not a problem since
Python won't deallocate it before the :class:`LargeObject` instance
Expand Down
24 changes: 12 additions & 12 deletions docs/contents/pg/query.rst
Original file line number Diff line number Diff line change
Expand Up @@ -328,19 +328,19 @@ is empty and of type :exc:`pg.MultipleResultsError` if it has multiple rows.

.. versionadded:: 5.1

listfields -- list field names of previous query result
-------------------------------------------------------
listfields -- list field names of query result
----------------------------------------------

.. method:: Query.listfields()

List field names of previous query result
List field names of query result

:returns: field names
:rtype: list
:raises TypeError: too many parameters

This method returns the list of field names defined for the
query result. The fields are in the same order as the result values.
This method returns the list of field names defined for the query result.
The fields are in the same order as the result values.

fieldname, fieldnum -- field name/number conversion
---------------------------------------------------
Expand Down Expand Up @@ -374,12 +374,12 @@ build a function that converts result list strings to their correct
type, using a hardcoded table definition. The number returned is the
field rank in the query result.

fieldinfo -- detailed info about fields of previous query result
----------------------------------------------------------------
fieldinfo -- detailed info about query result fields
----------------------------------------------------

.. method:: Query.fieldinfo([field])

Get information on one or all fields of the last query
Get information on one or all fields of the query

:param field: a column number or name (optional)
:type field: int or str
Expand All @@ -389,10 +389,10 @@ fieldinfo -- detailed info about fields of previous query result
:raises TypeError: too many parameters

If the ``field`` is specified by passing either a column number or a field
name, a four-tuple with information for the specified field of the previous
query result will be returned. If no ``field`` is specified, a tuple of
four-tuples for every field of the previous query result will be returned,
in the order as they appear in the query result.
name, a four-tuple with information for the specified field of the query
result will be returned. If no ``field`` is specified, a tuple of four-tuples
for every field of the previous query result will be returned, in the same
order as they appear in the query result.

The four-tuples contain the following information: The field name, the
internal OID number of the field type, the size in bytes of the column or a
Expand Down
2 changes: 1 addition & 1 deletion pgquery.c
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ _query_build_field_info(PGresult *res, int col_num) {
return info;
}

/* Get information on one or all fields in last result. */
/* Get information on one or all fields of the query result. */
static char query_fieldinfo__doc__[] =
"fieldinfo() -- return info on field(s) in query";

Expand Down

0 comments on commit f3d57a4

Please sign in to comment.