This is an automated email from the ASF dual-hosted git repository. jiayu pushed a commit to branch docs-mar-07 in repository https://gitbox.apache.org/repos/asf/sedona.git
commit b657e981add1d088a6d6409d17e3eed06f0499fc Author: Jia Yu <[email protected]> AuthorDate: Mon Mar 10 00:37:51 2025 -0700 Disable MD004 linter --- .github/linters/.markdown-lint.yml | 3 +++ docs/tutorial/files/stac-sedona-spark.md | 22 +++++++++++----------- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index 7c2ae00edc..44c251e0f1 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.github/linters/.markdown-lint.yml @@ -17,6 +17,9 @@ # https://github.com/DavidAnson/markdownlint#rules--aliases +# ul-style Unordered list style +MD004: false + # ul-indent - Unordered list indentation MD007: false diff --git a/docs/tutorial/files/stac-sedona-spark.md b/docs/tutorial/files/stac-sedona-spark.md index 5cd3d52fd4..062e6c5f55 100644 --- a/docs/tutorial/files/stac-sedona-spark.md +++ b/docs/tutorial/files/stac-sedona-spark.md @@ -275,11 +275,11 @@ Opens a connection to the specified STAC API URL. Parameters: --`url` (*str*): The URL of the STAC API to connect to. Example: `"https://planetarycomputer.microsoft.com/api/stac/v1"` +* `url` (*str*): The URL of the STAC API to connect to. Example: `"https://planetarycomputer.microsoft.com/api/stac/v1"` Returns: --`Client`: An instance of the `Client` class connected to the specified URL. +* `Client`: An instance of the `Client` class connected to the specified URL. --- @@ -288,11 +288,11 @@ Retrieves a collection client for the specified collection ID. Parameters: --`collection_id` (*str*): The ID of the collection to retrieve. Example: `"aster-l1t"` +* `collection_id` (*str*): The ID of the collection to retrieve. Example: `"aster-l1t"` Returns: --`CollectionClient`: An instance of the `CollectionClient` class for the specified collection. +* `CollectionClient`: An instance of the `CollectionClient` class for the specified collection. --- @@ -301,16 +301,16 @@ Searches for items in the specified collection with optional filters. Parameters: --`ids` (*Union[str, list]*): A variable number of item IDs to filter the items. Example: `"item_id1"` or `["item_id1", "item_id2"]` --`collection_id` (*str*): The ID of the collection to search in. Example: `"aster-l1t"` --`bbox` (*Optional[list]*): A list of bounding boxes for filtering the items, represented as `[min_lon, min_lat, max_lon, max_lat]`. Example: `[[ -180.0, -90.0, 180.0, 90.0 ]]` --`datetime` (*Optional[Union[str, datetime.datetime, list]]*): A single datetime, RFC 3339-compliant timestamp, or a list of date-time ranges. Example: `"2020-01-01T00:00:00Z"`, `datetime.datetime(2020, 1, 1)`, `[["2020-01-01T00:00:00Z", "2021-01-01T00:00:00Z"]]` --`max_items` (*Optional[int]*): The maximum number of items to return. Example: `100` --`return_dataframe` (*bool*): If `True` (default), return the result as a Spark DataFrame instead of an iterator of `PyStacItem` objects. Example: `True` +* `ids` (*Union[str, list]*): A variable number of item IDs to filter the items. Example: `"item_id1"` or `["item_id1", "item_id2"]` +* `collection_id` (*str*): The ID of the collection to search in. Example: `"aster-l1t"` +* `bbox` (*Optional[list]*): A list of bounding boxes for filtering the items, represented as `[min_lon, min_lat, max_lon, max_lat]`. Example: `[[ -180.0, -90.0, 180.0, 90.0 ]]` +* `datetime` (*Optional[Union[str, datetime.datetime, list]]*): A single datetime, RFC 3339-compliant timestamp, or a list of date-time ranges. Example: `"2020-01-01T00:00:00Z"`, `datetime.datetime(2020, 1, 1)`, `[["2020-01-01T00:00:00Z", "2021-01-01T00:00:00Z"]]` +* `max_items` (*Optional[int]*): The maximum number of items to return. Example: `100` +* `return_dataframe` (*bool*): If `True` (default), return the result as a Spark DataFrame instead of an iterator of `PyStacItem` objects. Example: `True` Returns: --*Union[Iterator[PyStacItem], DataFrame]*: An iterator of `PyStacItem` objects or a Spark DataFrame that matches the specified filters. +* *Union[Iterator[PyStacItem], DataFrame]*: An iterator of `PyStacItem` objects or a Spark DataFrame that matches the specified filters. ## References
