Repository navigation
[GH-3493] Document the raster, type, map and GeoArrow Python APIs - #3494
Merged
jiayuasu merged 1 commit intoOct 20, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Did you read the Contributor Guide?
Is this PR related to a ticket?
[GH-XXX] my subject. Closes Raster, type, map and GeoArrow Python APIs lack docstrings or parameter docs #3493What changes were proposed in this PR?
Docstring-only changes:
sql/types.py: class docstrings forGeometryType,GeographyType,Box2DType,Box3DTypeandRasterType, saying which Python objects their values become (Shapely geometries,Geography,Box2D,Box3DandSedonaRaster). TheUserDefinedTypemethods that Spark calls are unchanged.raster/sedona_raster.py: a class docstring forSedonaRastercovering how raster values reach Python, its constructor parameters, and the parameters and return value ofwith_bands.raster/meta.py: docstrings forAffineTransform(including the pixel-to-world formula),with_anchorandtranslate, and the fields ofSampleDimension.geoarrow/geoarrow.py: a docstring forcreate_spatial_dataframe, and the return value ofdataframe_to_arrow.maps/SedonaKepler.pyandmaps/SedonaPyDeck.py: class docstrings naming the extra each needs;create_map's parameter lines get their missing colon; the empty:param:lines increate_geometry_mapandcreate_scatterplot_mapget descriptions, andstrokedis documented.add_dfnow says that raster columns are left out.raster_utils/SedonaUtils.py: a class docstring, and aParameterssection fordisplay_image.How was this patch tested?
UserDefinedTypemethods were left off the types page, since Spark calls them and users don't.pre-commit runon them passes.Did this PR include necessary documentation updates?