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

breaking: fix geoJson parameter #318

Merged
merged 3 commits into from
Feb 2, 2024
Merged

breaking: fix geoJson parameter #318

merged 3 commits into from
Feb 2, 2024

Conversation

aMahanna
Copy link
Member

@aMahanna aMahanna commented Jan 19, 2024

Closes #234

We are currently using the parameter name ordered to specify whether a Geo Index should be created using GeoJson data-format or not, which can be confusing to users.

This PR just renames the parameter to geo_json

Ref: https://docs.arangodb.com/3.11/index-and-search/indexing/working-with-indexes/geo-spatial-indexes/

@aMahanna aMahanna requested a review from apetenchea January 23, 2024 16:44
Copy link
Member

@apetenchea apetenchea left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this change. Unfortunately there's no easy way around it. We'll have to state it clearly in the release notes.
It's worth doing a major release anyway, since we're adding support for multiple features.
As a user, at least the fix should be pretty obvious from the documentation.

arango/collection.py Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (805425d) 98.33% compared to head (08c4da0) 98.33%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #318   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          26       26           
  Lines        4201     4201           
=======================================
  Hits         4131     4131           
  Misses         70       70           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@aMahanna aMahanna merged commit 92b5f94 into main Feb 2, 2024
52 checks passed
@aMahanna aMahanna deleted the fix-geo-json-param branch February 2, 2024 20:43
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.

Documentation issue: ordered/geoJSON on collection.add_geo_index
3 participants