Skip to content

Conversation

@MrPowers
Copy link
Collaborator

@MrPowers MrPowers commented Jun 10, 2025

Did you read the Contributor Guide?

Is this PR related to a ticket?

No, this is a documentation update. The PR name follows the format [DOCS] my subject

What changes were proposed in this PR?

Adds a Sedona + Spark concept page on the different distance functions.

How was this patch tested?

All code snippets were tested locally.

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation. This is just a documentation update.

@MrPowers MrPowers requested a review from jiayuasu as a code owner June 10, 2025 18:38
@jiayuasu jiayuasu requested a review from Copilot June 11, 2025 09:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new documentation page on Sedona distance functions with Spark and updates existing concept pages to emphasize Spark usage.

  • Added a “Distance” concept page under tutorial/concepts
  • Updated spatial join and clustering headings to specify Spark context
  • Populated the new distance-spark.md with detailed examples of distance computations

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

File Description
mkdocs.yml Added “Distance” to the site navigation under Concepts
docs/tutorial/concepts/spatial-joins.md Appended Spark context to spatial join section headings
docs/tutorial/concepts/distance-spark.md New guide on computing various distances with Sedona and Spark
docs/tutorial/concepts/clustering-algorithms.md Appended Spark context to clustering headings
Comments suppressed due to low confidence (3)

docs/tutorial/concepts/spatial-joins.md:26

  • [nitpick] Headings mix "using Spark" and "with Spark" suffixes across sections. Consider standardizing on one phrasing (e.g., "with Spark") for consistency.
## Spatial join within using Spark

docs/tutorial/concepts/clustering-algorithms.md:20

  • [nitpick] The heading uses "with Apache Spark" while other docs use "with Spark". For uniformity, align the naming convention across all concept pages.
# Apache Sedona Clustering Algorithms with Apache Spark

docs/tutorial/concepts/distance-spark.md:117

  • The DataFrame was created with columns place1 and place2, but the snippet selects place1_name and place2_name, which will cause an error. Either rename the columns or select the correct names.
res.select("place1_name", "place2_name", "st_distance_spheroid").show()

@jiayuasu jiayuasu merged commit fb9c495 into apache:master Jun 11, 2025
4 checks passed
jiayuasu pushed a commit that referenced this pull request Jun 19, 2025
* [DOCS] add page on distance computations with spark

* lint

* make concepts pages specific to spark
Kontinuation pushed a commit to Kontinuation/sedona that referenced this pull request Jan 21, 2026
* [DOCS] add page on distance computations with spark

* lint

* make concepts pages specific to spark
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants