Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Run Python black on Markdown code blocks #1797

Merged
merged 1 commit into from
Feb 11, 2025

Conversation

jbampton
Copy link
Member

Did you read the Contributor Guide?

Is this PR related to a JIRA ticket?

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

refs #1796

Just Markdown changes in this PR.

What changes were proposed in this PR?

https://github.com/adamchainz/blacken-docs

Ran the black hook on the Markdown code blocks.

Errors left:

blacken-docs.............................................................Failed
- hook id: blacken-docs
- exit code: 2

docs/tutorial/sql.md:372: code block parse error Cannot parse: 2:0:  .selectExpr("explode(features) as features") # Explode the envelope to get one feature per row.
docs/api/sql/Visualization_SedonaKepler.md:40: code block parse error Cannot parse: 1:13: create_map(df: SedonaDataFrame=None, name: str='unnamed', config: dict=None) -> map
docs/api/sql/Visualization_SedonaKepler.md:65: code block parse error Cannot parse: 1:14: add_df(map, df: SedonaDataFrame, name: str='unnamed')
docs/setup/fabric.md:83: code block parse error Cannot parse: 1:0: %%configure -f
docs/setup/fabric.md:128: code block parse error Cannot parse: 1:0: %%configure -f
docs/tutorial/rdd.md:678: code block parse error Cannot parse: 2:0:     from sedona.core.enums import GridType
docs/tutorial/geopandas-shapely.md:74: code block parse error Cannot parse: 4:33: config = SedonaContext.builder().
docs/tutorial/geopandas-shapely.md:121: code block parse error Cannot parse: 4:33: config = SedonaContext.builder().
docs/setup/glue.md:53: code block parse error Cannot parse: 2:0: %extra_jars https://repo1.maven.org/maven2/org/apache/sedona/sedona-spark-shaded-3.3_2.12/{{ sedona.current_version }}/sedona-spark-shaded-3.3_2.12-{{ sedona.current_version }}.jar, https://repo1.maven.org/maven2/org/datasyslab/geotools-wrapper/{{ sedona.current_geotools }}/geotools-wrapper-{{ sedona.current_geotools }}.jar
docs/setup/glue.md:61: code block parse error Cannot parse: 1:0: %idle_timeout 2880
docs/api/sql/Visualization_SedonaPyDeck.md:43: code block parse error Cannot parse: 4:0: <line number missing in source>
docs/api/sql/Visualization_SedonaPyDeck.md:62: code block parse error Cannot parse: 2:72:                                                 map_provider=None, api_keys=None, elevation_col=0, stroked=True)
docs/api/sql/Visualization_SedonaPyDeck.md:89: code block parse error Cannot parse: 2:76:                            map_style=None, map_provider=None, api_keys=None)
docs/api/sql/Visualization_SedonaPyDeck.md:109: code block parse error Cannot parse: 2:49:                 map_provider=None, api_keys=None)

How was this patch tested?

Ran pre-commit run --all-files

This auto fixed most of the code blocks.

Did this PR include necessary documentation updates?

  • No, this PR does not affect any public API so no need to change the documentation.

@jbampton jbampton requested a review from jiayuasu as a code owner February 10, 2025 17:14
@jiayuasu jiayuasu changed the title Run Python black on Markdown code blocks [DOCS] Run Python black on Markdown code blocks Feb 11, 2025
@jiayuasu jiayuasu merged commit e7a5a3d into apache:master Feb 11, 2025
4 checks passed
@jbampton jbampton deleted the blacken-docs branch February 11, 2025 10:07
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