Skip to content

[GH-3493] Document the raster, type, map and GeoArrow Python APIs - #3494

Merged
jiayuasu merged 1 commit into
apache:masterfrom
jiayuasu:docs/raster-maps-types-docstrings
Oct 20, 2026
Merged

jiayuasu merged 1 commit into
apache:masterfrom
jiayuasu:docs/raster-maps-types-docstrings

Conversation

@jiayuasu

Copy link
Copy Markdown
Member

Did you read the Contributor Guide?

Is this PR related to a ticket?

What changes were proposed in this PR?

Docstring-only changes:

  • sql/types.py: class docstrings for GeometryType, GeographyType, Box2DType, Box3DType and RasterType, saying which Python objects their values become (Shapely geometries, Geography, Box2D, Box3D and SedonaRaster). The UserDefinedType methods that Spark calls are unchanged.
  • raster/sedona_raster.py: a class docstring for SedonaRaster covering how raster values reach Python, its constructor parameters, and the parameters and return value of with_bands.
  • raster/meta.py: docstrings for AffineTransform (including the pixel-to-world formula), with_anchor and translate, and the fields of SampleDimension.
  • geoarrow/geoarrow.py: a docstring for create_spatial_dataframe, and the return value of dataframe_to_arrow.
  • maps/SedonaKepler.py and maps/SedonaPyDeck.py: class docstrings naming the extra each needs; create_map's parameter lines get their missing colon; the empty :param: lines in create_geometry_map and create_scatterplot_map get descriptions, and stroked is documented. add_df now says that raster columns are left out.
  • raster_utils/SedonaUtils.py: a class docstring, and a Parameters section for display_image.

How was this patch tested?

  • Parsed the package with griffe and checked every documented parameter against its signature, using the generator for an API reference built from these docstrings, with pages for these modules. The 47 gaps in them go to none. The UserDefinedType methods were left off the types page, since Spark calls them and users don't.
  • The files compile, and pre-commit run on them passes.

Did this PR include necessary documentation updates?

  • Yes, this PR updates the Python docstrings.

@jiayuasu jiayuasu added this to the sedona-2.0.0 milestone Oct 20, 2026
@jiayuasu
jiayuasu merged commit b56843e into apache:master Oct 20, 2026
34 checks passed
@jiayuasu
jiayuasu deleted the docs/raster-maps-types-docstrings branch October 20, 2026 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Raster, type, map and GeoArrow Python APIs lack docstrings or parameter docs

1 participant