Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation update for gspread.worksheet.Worksheet.get_all_records #1529

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Documentation update for gspread.worksheet.Worksheet.get_all_records #1529

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions gspread/worksheet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,12 +509,12 @@ def get_all_records(
values.

This method uses the function :func:`gspread.utils.to_records` to build the resulting
records. It mainly wraps around the function and handle the simplest use case
using a header row (default = 1) and the the reste of the entire sheet.
records. It mainly wraps around the function and handles the simplest use case
using a header row (default = 1) and the rest of the entire sheet.

.. note::

for any particular use-case, please get your dataset, your headers
For more particular use-cases, please get your dataset, your headers and
then use the function :func:`gspread.utils.to_records` to build the records.

Cell values are numericised (strings that can be read as ints or floats
Expand All @@ -526,7 +526,7 @@ def get_all_records(

.. note::

returned dictionaries will contain all headers even if not included in this list
Returned dictionaries will contain all headers even if not included in this list.
:param value_render_option: (optional) Determines how values should
be rendered in the output. See `ValueRenderOption`_ in
the Sheets API.
Expand Down