Skip to content

Commit a870421

Browse files
authored
docs: update Session doctrings to include exceptions (#1130)
1 parent 7ac6639 commit a870421

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed

bigframes/session/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ def read_gbq_query(
500500
501501
Raises:
502502
ValueError:
503-
When both columns (preferred) and col_order are specified.
503+
When both ``columns`` and ``col_order`` are specified.
504504
"""
505505
# NOTE: This method doesn't (yet) exist in pandas or pandas-gbq, so
506506
# these docstrings are inline.
@@ -552,7 +552,7 @@ def read_gbq_table(
552552
553553
Raises:
554554
ValueError:
555-
When both columns (preferred) and col_order are specified.
555+
When both ``columns`` and ``col_order`` are specified.
556556
"""
557557
# NOTE: This method doesn't (yet) exist in pandas or pandas-gbq, so
558558
# these docstrings are inline.

third_party/bigframes_vendored/pandas/io/gbq.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,11 @@ def read_gbq(
160160
bigframes.exceptions.DefaultIndexWarning:
161161
Using the default index is discouraged, such as with clustered
162162
or partitioned tables without primary keys.
163+
ValueError:
164+
When both ``columns`` and ``col_order`` are specified.
165+
ValueError:
166+
If ``configuration`` is specified when directly reading
167+
from a table.
163168
164169
Returns:
165170
bigframes.pandas.DataFrame: A DataFrame representing results of the query or table.

third_party/bigframes_vendored/pandas/io/parsers/readers.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,5 +237,7 @@ def read_json(
237237
bigframes.exceptions.DefaultIndexWarning:
238238
Using the default index is discouraged, such as with clustered
239239
or partitioned tables without primary keys.
240+
ValueError:
241+
``lines`` is only valid when ``orient`` is ``records``.
240242
"""
241243
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

0 commit comments

Comments
 (0)