Repository navigation
[GH-3495] Fix the GeoPandas API buffer docs, read_file warning and from_wkt/from_wkb arguments - #3496
Merged
Conversation
…and from_wkt/from_wkb arguments
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: misleading buffer single_sided docs, read_file warns about table_name, from_wkt/from_wkb ignore keyword arguments #3495What changes were proposed in this PR?
buffer: thesingle_sideddocstring now says what the code does, as in GeoPandas: the sign ofdistancepicks the side. A new test compares a negative-distance single-sided buffer with GeoPandas.read_fileno longer reportstable_nameas an unsupported argument, and still warns about the others.read_parquetno longer passes its keyword arguments on toread_file, so it warns about them once.GeoSeries.from_wktandGeoSeries.from_wkbraiseTypeErrorfor keyword arguments other thanname, likeGeoSeries.from_xy, and their docstrings say so. This is a behavior change: a call that passed another keyword argument, which was ignored, now raises.How was this patch tested?
test_bufferintest_match_geopandas_series.pygets the negative-distance case;test_read_file_warns_only_about_unsupported_argumentsintest_io.py;test_wkt_wkb_keyword_argumentsintest_geoseries.py.TypeErrornaming the unsupported arguments, and still raiseNotImplementedErrorforon_invalidother than'raise'. The tests that need a Spark session with Sedona run in CI.pre-commit runon the changed files passes.Did this PR include necessary documentation updates?
buffer,read_file,from_wktandfrom_wkb.