Skip to content

Commit

Permalink
Added doc string for get_column_headers
Browse files Browse the repository at this point in the history
  • Loading branch information
muddi900 committed Nov 26, 2024
1 parent 4017c3d commit 2579cc5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions gspread/worksheet.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,13 @@ def __init__(
self._spreadsheet = spreadsheet

def get_column_headers(self, header_row: Optional[int] = None) -> List[str]:
"""Get the column headers a list of strings.
:param header_row: (optional) Row number(1-indexed) of column titles. Defualts to 1.
:type header_row: int
"""

return self.row_values(header_row or 1)

def __repr__(self) -> str:
Expand Down

0 comments on commit 2579cc5

Please sign in to comment.