Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 15e9fd5

Browse files
authoredOct 24, 2024
docs: update docstrings of DataFrame and related files (#1092)
* docs: update docstrings of DataFrame and related files * Fix doctrings to resolve comments * Fix return types * Fixed return types
1 parent 461d3b1 commit 15e9fd5

File tree

3 files changed

+204
-150
lines changed

3 files changed

+204
-150
lines changed
 

‎bigframes/dataframe.py

+11-5
Original file line numberDiff line numberDiff line change
@@ -379,15 +379,20 @@ def _to_sql_query(
379379
whether to include index columns.
380380
381381
Returns:
382-
a tuple of (sql_string, index_column_id_list, index_column_label_list).
382+
Tuple[sql_string, index_column_id_list, index_column_label_list]:
383383
If include_index is set to False, index_column_id_list and index_column_label_list
384384
return empty lists.
385385
"""
386386
return self._block.to_sql_query(include_index, enable_cache=enable_cache)
387387

388388
@property
389389
def sql(self) -> str:
390-
"""Compiles this DataFrame's expression tree to SQL."""
390+
"""Compiles this DataFrame's expression tree to SQL.
391+
392+
Returns:
393+
str:
394+
string representing the compiled SQL.
395+
"""
391396
include_index = self._has_index and (
392397
self.index.name is not None or len(self.index.names) > 1
393398
)
@@ -399,8 +404,9 @@ def query_job(self) -> Optional[bigquery.QueryJob]:
399404
"""BigQuery job metadata for the most recent query.
400405
401406
Returns:
402-
The most recent `QueryJob
403-
<https://cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.job.QueryJob>`_.
407+
None or google.cloud.bigquery.QueryJob:
408+
The most recent `QueryJob
409+
<https://cloud.google.com/python/docs/reference/bigquery/latest/google.cloud.bigquery.job.QueryJob>`_.
404410
"""
405411
if self._query_job is None:
406412
self._set_internal_query_job(self._compute_dry_run())
@@ -3763,7 +3769,7 @@ def cache(self):
37633769
Useful if the dataframe will be used multiple times, as this will avoid recomputating the shared intermediate value.
37643770
37653771
Returns:
3766-
DataFrame: Self
3772+
bigframes.pandas.DataFrame: DataFrame
37673773
"""
37683774
return self._cached(force=True)
37693775

There was a problem loading the remainder of the diff.

0 commit comments

Comments
 (0)
Failed to load comments.