Skip to content

Commit 1337600

Browse files
jorisvandenbosschepull[bot]
authored andcommitted
DOC: avoid StorageOptions type alias in docstrings (#35894)
1 parent f65e517 commit 1337600

File tree

6 files changed

+16
-8
lines changed

6 files changed

+16
-8
lines changed

pandas/io/excel/_base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -200,13 +200,13 @@
200200
Duplicate columns will be specified as 'X', 'X.1', ...'X.N', rather than
201201
'X'...'X'. Passing in False will cause data to be overwritten if there
202202
are duplicate names in the columns.
203-
storage_options : StorageOptions
203+
storage_options : dict, optional
204204
Extra options that make sense for a particular storage connection, e.g.
205205
host, port, username, password, etc., if using a URL that will
206206
be parsed by ``fsspec``, e.g., starting "s3://", "gcs://". An error
207207
will be raised if providing this argument with a local path or
208208
a file-like buffer. See the fsspec and backend storage implementation
209-
docs for the set of allowed keys and values
209+
docs for the set of allowed keys and values.
210210
211211
.. versionadded:: 1.2.0
212212

pandas/io/excel/_odfreader.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class _ODFReader(_BaseExcelReader):
1818
----------
1919
filepath_or_buffer : string, path to be parsed or
2020
an open readable stream.
21-
storage_options : StorageOptions
21+
storage_options : dict, optional
2222
passed to fsspec for appropriate URLs (see ``get_filepath_or_buffer``)
2323
"""
2424

pandas/io/excel/_openpyxl.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ def __init__(
479479
----------
480480
filepath_or_buffer : string, path object or Workbook
481481
Object to be parsed.
482-
storage_options : StorageOptions
482+
storage_options : dict, optional
483483
passed to fsspec for appropriate URLs (see ``get_filepath_or_buffer``)
484484
"""
485485
import_optional_dependency("openpyxl")

pandas/io/excel/_pyxlsb.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ def __init__(
1919
----------
2020
filepath_or_buffer : str, path object, or Workbook
2121
Object to be parsed.
22-
storage_options : StorageOptions
22+
storage_options : dict, optional
2323
passed to fsspec for appropriate URLs (see ``get_filepath_or_buffer``)
2424
"""
2525
import_optional_dependency("pyxlsb")

pandas/io/excel/_xlrd.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def __init__(self, filepath_or_buffer, storage_options: StorageOptions = None):
1717
----------
1818
filepath_or_buffer : string, path object or Workbook
1919
Object to be parsed.
20-
storage_options : StorageOptions
20+
storage_options : dict, optional
2121
passed to fsspec for appropriate URLs (see ``get_filepath_or_buffer``)
2222
"""
2323
err_msg = "Install xlrd >= 1.0.0 for Excel support"

pandas/io/feather_format.py

+10-2
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,13 @@ def to_feather(df: DataFrame, path, storage_options: StorageOptions = None, **kw
1616
----------
1717
df : DataFrame
1818
path : string file path, or file-like object
19-
2019
storage_options : dict, optional
2120
Extra options that make sense for a particular storage connection, e.g.
2221
host, port, username, password, etc., if using a URL that will
2322
be parsed by ``fsspec``, e.g., starting "s3://", "gcs://". An error
2423
will be raised if providing this argument with a local path or
2524
a file-like buffer. See the fsspec and backend storage implementation
26-
docs for the set of allowed keys and values
25+
docs for the set of allowed keys and values.
2726
2827
.. versionadded:: 1.2.0
2928
@@ -106,6 +105,15 @@ def read_feather(
106105
Whether to parallelize reading using multiple threads.
107106
108107
.. versionadded:: 0.24.0
108+
storage_options : dict, optional
109+
Extra options that make sense for a particular storage connection, e.g.
110+
host, port, username, password, etc., if using a URL that will
111+
be parsed by ``fsspec``, e.g., starting "s3://", "gcs://". An error
112+
will be raised if providing this argument with a local path or
113+
a file-like buffer. See the fsspec and backend storage implementation
114+
docs for the set of allowed keys and values.
115+
116+
.. versionadded:: 1.2.0
109117
110118
Returns
111119
-------

0 commit comments

Comments
 (0)