Skip to content

DOC: Inline docstrings in pandas/io/excel/_odfreader.py (GH#62437) #63943

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
mroeschke merged 5 commits into from
Jan 29, 2026
+9 −4
Merged

DOC: Inline docstrings in pandas/io/excel/_odfreader.py (GH#62437) #63943

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b8a14cd
DOC: Inline docstrings in pandas/io/excel/_odfreader.py (GH#62437)
accountTimo Jan 29, 2026
53b68d7
STY: Fix docstring line length and imports
accountTimo Jan 29, 2026
986829b
STY: Break long docstring lines manually ugh
accountTimo Jan 29, 2026
f9f82ee
STY: Shorten lines even more to please ruff
accountTimo Jan 29, 2026
f0bb362
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 29, 2026
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
13 changes: 9 additions & 4 deletions pandas/io/excel/_odfreader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,8 @@
StorageOptions,
)
from pandas.compat._optional import import_optional_dependency
from pandas.util._decorators import doc

import pandas as pd
from pandas.core.shared_docs import _shared_docs

from pandas.io.excel._base import BaseExcelReader

Expand All @@ -27,7 +25,6 @@
from pandas._libs.tslibs.nattype import NaTType


@doc(storage_options=_shared_docs["storage_options"])
class ODFReader(BaseExcelReader["OpenDocument"]):
def __init__(
self,
Expand All @@ -42,7 +39,15 @@ def __init__(
----------
filepath_or_buffer : str, path to be parsed or
an open readable stream.
{storage_options}
storage_options : dict, optional
Extra options that make sense for a particular storage connection,
e.g. host, port, username, password, etc. For HTTP(S) URLs the
key-value pairs are forwarded to ``urllib.request.Request`` as
header options. For other URLs (e.g. starting with "s3://", and
"gcs://") the key-value pairs are forwarded to ``fsspec.open``.
Please see ``fsspec`` and ``urllib`` for more details, and for
more examples on storage options refer `here
<https://pandas.pydata.org/docs/user_guide/io.html?#reading-writing-remote-files>`__.
engine_kwargs : dict, optional
Arbitrary keyword arguments passed to excel engine.
"""
Expand Down
Loading