Repository navigation
[GH-3490] Document the GeoPandas API, STAC and SedonaContext parameters - #3491
Merged
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 GeoPandas API and STAC docstrings leave parameters undocumented or misparsed #3490What changes were proposed in this PR?
Docstring changes in
python/sedona/spark/geopandas,python/sedona/spark/stac/collection_client.pyandpython/sedona/spark/SedonaContext.py, plus the removal of one duplicate property:Note:lines in NumPy-style docstrings becomeNotessections or plain prose inGeoDataFrame.to_arrow,GeoDataFrame.to_feather,GeoSeries.to_json, andSpatialIndexwith itsquery,nearestandintersectionmethods, so parsers read theirParameterssections correctly.GeoDataFrameconstructor (dtype,copy),GeoDataFrame.sjoin_nearest(taken fromsedona.spark.geopandas.sjoin_nearest),rename_geometry,GeoSeries.from_xy,fillna(inplace),GeoSeries.to_file(schema, not applicable as inGeoDataFrame.to_file),plot(*args,**kwargs),read_parquet(path),SpatialIndex(geometry) andCollectionClient.load_items_df(taken fromget_dataframe).**kwargsare documented as what the code does with them: ignored in theGeoDataFrameandGeoSeriesconstructors,bufferandfillna; passed tojson.dumpsinto_jsonand toread_fileinGeoSeries.from_file; onlytable_nameread byread_file; ignored with a warning byread_parquet.GeoDataFrame.crs,GeoSeries.geometry,GeoSeries.to_geoframe,GeoSeries.to_spark_pandasand theSedonaContextclass.GeoSeries.plotno longer documents ansparameter,GeoSeries.from_filecreates aGeoSeries,GeoSeries.from_xysays onlynameis accepted through**kwargs, andread_parquet's example no longer claims to select columns.GeoSeries.geometrydefinition, which was identical to the first and overrode it. There are no other code changes.How was this patch tested?
NotImplementedErrorand are left out of the reference, and theSedonaContextgap is closed. The rendered pages show every parameter, and the notes render as notes.pre-commit runon them passes.Did this PR include necessary documentation updates?