Skip to content

Commit

Permalink
docs: Fix outdated hyperlinks in documentation (#2634)
Browse files Browse the repository at this point in the history
  • Loading branch information
LeonLuttenberger authored Jan 23, 2024
1 parent ae49525 commit 2f3ca80
Show file tree
Hide file tree
Showing 9 changed files with 870 additions and 86 deletions.
4 changes: 2 additions & 2 deletions awswrangler/catalog/_create.py
Original file line number Diff line number Diff line change
Expand Up @@ -1131,7 +1131,7 @@ def create_csv_table(
If True allows schema evolution (new or missing columns), otherwise a exception will be raised.
(Only considered if dataset=True and mode in ("append", "overwrite_partitions"))
Related tutorial:
https://aws-sdk-pandas.readthedocs.io/en/2.11.0/tutorials/014%20-%20Schema%20Evolution.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/014%20-%20Schema%20Evolution.html
sep : str
String of length 1. Field delimiter for the output file.
skip_header_line_count : Optional[int]
Expand Down Expand Up @@ -1317,7 +1317,7 @@ def create_json_table(
If True allows schema evolution (new or missing columns), otherwise a exception will be raised.
(Only considered if dataset=True and mode in ("append", "overwrite_partitions"))
Related tutorial:
https://aws-sdk-pandas.readthedocs.io/en/2.11.0/tutorials/014%20-%20Schema%20Evolution.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/014%20-%20Schema%20Evolution.html
serde_library : Optional[str]
Specifies the SerDe Serialization library which will be used. You need to provide the Class library name
as a string.
Expand Down
5 changes: 3 additions & 2 deletions awswrangler/opensearch/_write.py
Original file line number Diff line number Diff line change
Expand Up @@ -489,12 +489,13 @@ def index_documents(
use_threads: bool | int = False,
**kwargs: Any,
) -> dict[str, Any]:
"""Index all documents to OpenSearch index.
"""
Index all documents to OpenSearch index.
Note
----
`max_retries`, `initial_backoff`, and `max_backoff` are not supported with parallel bulk
(when `use_threads`is set to True).
(when `use_threads` is set to True).
Note
----
Expand Down
4 changes: 2 additions & 2 deletions awswrangler/s3/_read_orc.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ def read_orc(
must return a bool, True to read the partition or False to ignore it.
Ignored if `dataset=False`.
E.g ``lambda x: True if x["year"] == "2020" and x["month"] == "1" else False``
https://aws-data-wrangler.readthedocs.io/en/3.1.1/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
columns : List[str], optional
List of columns to read from the file(s).
validate_schema : bool, default False
Expand Down Expand Up @@ -386,7 +386,7 @@ def read_orc_table(
must return a bool, True to read the partition or False to ignore it.
Ignored if `dataset=False`.
E.g ``lambda x: True if x["year"] == "2020" and x["month"] == "1" else False``
https://aws-sdk-pandas.readthedocs.io/en/3.1.1/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
columns : List[str], optional
List of columns to read from the file(s).
validate_schema : bool, default False
Expand Down
2 changes: 1 addition & 1 deletion awswrangler/s3/_read_parquet.py
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ def read_parquet(
must return a bool, True to read the partition or False to ignore it.
Ignored if `dataset=False`.
E.g ``lambda x: True if x["year"] == "2020" and x["month"] == "1" else False``
https://aws-data-wrangler.readthedocs.io/en/3.5.0/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/023%20-%20Flexible%20Partitions%20Filter.html
columns : List[str], optional
List of columns to read from the file(s).
validate_schema : bool, default False
Expand Down
4 changes: 2 additions & 2 deletions awswrangler/s3/_write_orc.py
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ def to_orc(
concurrent_partitioning: bool
If True will increase the parallelism level during the partitions writing. It will decrease the
writing time and increase the memory usage.
https://aws-sdk-pandas.readthedocs.io/en/3.1.1/tutorials/022%20-%20Writing%20Partitions%20Concurrently.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/022%20-%20Writing%20Partitions%20Concurrently.html
mode: str, optional
``append`` (Default), ``overwrite``, ``overwrite_partitions``. Only takes effect if dataset=True.
catalog_versioning : bool
Expand All @@ -413,7 +413,7 @@ def to_orc(
If True allows schema evolution (new or missing columns), otherwise a exception will be raised. True by default.
(Only considered if dataset=True and mode in ("append", "overwrite_partitions"))
Related tutorial:
https://aws-sdk-pandas.readthedocs.io/en/3.1.1/tutorials/014%20-%20Schema%20Evolution.html
https://aws-sdk-pandas.readthedocs.io/en/3.5.2/tutorials/014%20-%20Schema%20Evolution.html
database : str, optional
Glue/Athena catalog: Database name.
table : str, optional
Expand Down
Loading

0 comments on commit 2f3ca80

Please sign in to comment.