Skip to content

Commit 9249e3d

Browse files
docs: adding s3_additional_kwargs to docstrings (#2627)
1 parent 498b586 commit 9249e3d

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

awswrangler/s3/_read_text.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,8 @@ def read_csv(
237237
Ignored if `dataset=False`.
238238
E.g ``lambda x: True if x["year"] == "2020" and x["month"] == "1" else False``
239239
https://aws-sdk-pandas.readthedocs.io/en/3.5.1/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
240+
s3_additional_kwargs: dict[str, Any], optional
241+
Forwarded to botocore requests.
240242
ray_args: typing.RaySettings, optional
241243
Parameters of the Ray Modin settings. Only used when distributed computing is used with Ray and Modin installed.
242244
pandas_kwargs :
@@ -397,6 +399,8 @@ def read_fwf(
397399
Ignored if `dataset=False`.
398400
E.g ``lambda x: True if x["year"] == "2020" and x["month"] == "1" else False``
399401
https://aws-sdk-pandas.readthedocs.io/en/3.5.1/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
402+
s3_additional_kwargs: dict[str, Any], optional
403+
Forwarded to botocore requests.
400404
ray_args: typing.RaySettings, optional
401405
Parameters of the Ray Modin settings. Only used when distributed computing is used with Ray and Modin installed.
402406
pandas_kwargs:
@@ -564,6 +568,8 @@ def read_json(
564568
Ignored if `dataset=False`.
565569
E.g ``lambda x: True if x["year"] == "2020" and x["month"] == "1" else False``
566570
https://aws-sdk-pandas.readthedocs.io/en/3.5.1/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
571+
s3_additional_kwargs: dict[str, Any], optional
572+
Forwarded to botocore requests.
567573
ray_args: typing.RaySettings, optional
568574
Parameters of the Ray Modin settings. Only used when distributed computing is used with Ray and Modin installed.
569575
pandas_kwargs:

0 commit comments

Comments
 (0)