Skip to content

Commit

Permalink
Improve docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Cito committed Sep 3, 2023
1 parent 4222457 commit 50c8e42
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions pg.py
Original file line number Diff line number Diff line change
Expand Up @@ -2691,16 +2691,18 @@ def get_as_list(self, table, what=None, where=None,
The parameter 'what' can restrict the query to only return a
subset of the table columns. It can be a string, list or a tuple.
The parameter 'where' can restrict the query to only return a
subset of the table rows. It can be a string, list or a tuple
of SQL expressions that all need to be fulfilled. The parameter
'order' specifies the ordering of the rows. It can also be a
other string, list or a tuple. If no ordering is specified,
the result will be ordered by the primary key(s) or all columns
if no primary key exists. You can set 'order' to False if you
don't care about the ordering. The parameters 'limit' and 'offset'
can be integers specifying the maximum number of rows returned
and a number of rows skipped over.
of SQL expressions that all need to be fulfilled.
The parameter 'order' specifies the ordering of the rows. It can
also be a string, list or a tuple. If no ordering is specified,
the result will be ordered by the primary key(s) or all columns if
no primary key exists. You can set 'order' to False if you don't
care about the ordering. The parameters 'limit' and 'offset' can be
integers specifying the maximum number of rows returned and a number
of rows skipped over.
If you set the 'scalar' option to True, then instead of the
named tuples you will get the first items of these tuples.
Expand Down

0 comments on commit 50c8e42

Please sign in to comment.