Skip to content

Commit ecc7e97

Browse files
committed
Fix read_excel() doc typos. #509
1 parent 4d97092 commit ecc7e97

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

awswrangler/s3/_read_excel.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def read_excel(
3434
Parameters
3535
----------
3636
path : Union[str, List[str]]
37-
S3 path (e.g. ``[s3://bucket/key0``).
37+
S3 path (e.g. ``s3://bucket/key.xlsx``).
3838
use_threads : bool
3939
True to enable concurrent requests, False to disable multiple threads.
4040
If enabled os.cpu_count() will be used as the max number of threads.
@@ -45,7 +45,7 @@ def read_excel(
4545
pandas_kwargs:
4646
KEYWORD arguments forwarded to pandas.read_excel(). You can NOT pass `pandas_kwargs` explicit, just add valid
4747
Pandas arguments in the function call and Wrangler will accept it.
48-
e.g. wr.s3.read_excel(path, na_rep="", verbose=True)
48+
e.g. wr.s3.read_excel("s3://bucket/key.xlsx", na_rep="", verbose=True)
4949
https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_excel.html
5050
5151
Returns
@@ -58,15 +58,14 @@ def read_excel(
5858
Reading an EXCEL file
5959
6060
>>> import awswrangler as wr
61-
>>> df = wr.s3.read_excel('s3://bucket/key')
61+
>>> df = wr.s3.read_excel('s3://bucket/key.xlsx')
6262
6363
"""
6464
if "pandas_kwargs" in pandas_kwargs:
6565
raise exceptions.InvalidArgument(
6666
"You can NOT pass `pandas_kwargs` explicit, just add valid "
6767
"Pandas arguments in the function call and Wrangler will accept it."
68-
"e.g. wr.s3.read_excel(path, na_rep="
69-
", verbose=True)"
68+
"e.g. wr.s3.read_excel('s3://bucket/key.xlsx', na_rep='', verbose=True)"
7069
)
7170
session: boto3.Session = _utils.ensure_session(session=boto3_session)
7271
with open_s3_object(

0 commit comments

Comments
 (0)