Skip to content

fix: correct typos in docstrings across classes and functions #190

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

Merged
dimastbk merged 1 commit into from
Feb 27, 2026
Merged

fix: correct typos in docstrings across classes and functions #190

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
16 changes: 8 additions & 8 deletions python/python_calamine/_python_calamine.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class CalamineSheet:
| datetime.timedelta
]
]:
"""Retunrning data from sheet as list of lists.
"""Returning data from sheet as list of lists.

Args:
skip_empty_area (bool):
Expand All @@ -110,7 +110,7 @@ class CalamineSheet:
| datetime.timedelta
]
]:
"""Retunrning data from sheet as iterator of lists."""
"""Returning data from sheet as iterator of lists."""

@property
def merged_cell_ranges(
Expand All @@ -121,7 +121,7 @@ class CalamineSheet:
Support only for xlsx/xls.

Returns:
list of merged cell ranges (tuple[start coordinate, end coordinate]) or None for unsuported format
list of merged cell ranges (tuple[start coordinate, end coordinate]) or None for unsupported format
"""

@typing.final
Expand Down Expand Up @@ -172,7 +172,7 @@ class CalamineTable:
| datetime.timedelta
]
]:
"""Retunrning data from table as list of lists."""
"""Returning data from table as list of lists."""

@typing.final
class CalamineWorkbook:
Expand All @@ -191,7 +191,7 @@ class CalamineWorkbook:
"""Determining type of pyobject and reading from it.

Args:
path_or_filelike (str | os.PathLike | ReadBuffer): path to file or IO (must imlpement read/seek methods).
path_or_filelike (str | os.PathLike | ReadBuffer): path to file or IO (must implement read/seek methods).
load_tables (bool): load Excel tables (supported for XLSX only).
"""

Expand All @@ -213,7 +213,7 @@ class CalamineWorkbook:
"""Reading file from IO.

Args:
filelike : IO (must imlpement read/seek methods).
filelike : IO (must implement read/seek methods).
load_tables (bool): load Excel tables (supported for XLSX only).
"""

Expand Down Expand Up @@ -273,7 +273,7 @@ class CalamineWorkbook:

Raises:
WorkbookClosed: If workbook already closed.
WorksheetNotFound: If worksheet not found in workbook.
TableNotFound: If table not found in workbook.
"""

class CalamineError(Exception): ...
Expand All @@ -292,7 +292,7 @@ def load_workbook(
"""Determining type of pyobject and reading from it.

Args:
path_or_filelike (str | os.PathLike | ReadBuffer): path to file or IO (must imlpement read/seek methods).
path_or_filelike (str | os.PathLike | ReadBuffer): path to file or IO (must implement read/seek methods).
load_tables (bool): load Excel tables (supported for XLSX only).
"""

Expand Down