Skip to content

Commit 0901352

Browse files
authored
DOC: Replace @doc decorator with inline docstring in pandas/io/html.py (#63411)
1 parent 5a182b3 commit 0901352

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

pandas/io/html.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@
2424
AbstractMethodError,
2525
EmptyDataError,
2626
)
27-
from pandas.util._decorators import (
28-
doc,
29-
set_module,
30-
)
27+
from pandas.util._decorators import set_module
3128
from pandas.util._validators import check_dtype_backend
3229

3330
from pandas.core.dtypes.common import is_list_like
@@ -36,7 +33,6 @@
3633
from pandas.core.indexes.base import Index
3734
from pandas.core.indexes.multi import MultiIndex
3835
from pandas.core.series import Series
39-
from pandas.core.shared_docs import _shared_docs
4036

4137
from pandas.io.common import (
4238
get_handle,
@@ -1024,7 +1020,6 @@ def _parse(
10241020

10251021

10261022
@set_module("pandas")
1027-
@doc(storage_options=_shared_docs["storage_options"])
10281023
def read_html(
10291024
io: FilePath | ReadBuffer[str],
10301025
*,
@@ -1155,7 +1150,15 @@ def read_html(
11551150
11561151
.. versionadded:: 2.0
11571152
1158-
{storage_options}
1153+
storage_options : dict, optional
1154+
Extra options that make sense for a particular storage connection, e.g.
1155+
host, port, username, password, etc. For HTTP(S) URLs the key-value pairs
1156+
are forwarded to ``urllib.request.Request`` as header options. For other
1157+
URLs (e.g. starting with "s3://", and "gcs://") the key-value pairs are
1158+
forwarded to ``fsspec.open``. Please see ``fsspec`` and ``urllib`` for more
1159+
details, and for more examples on storage options refer `here
1160+
<https://pandas.pydata.org/docs/user_guide/io.html?
1161+
highlight=storage_options#reading-writing-remote-files>`_.
11591162
11601163
.. versionadded:: 2.1.0
11611164

0 commit comments

Comments
 (0)