docs(graphile-postgis): lead spatial-relation examples with ORM where: shape#994
Merged
pyramation merged 1 commit intomainfrom Apr 17, 2026
Merged
Conversation
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Summary
Docs-only follow-up to #993. The README for
@spatialRelationpreviously only showed GraphQLfilter:examples, but most consumers use the generated ORM (where:). This adds ORM-shaped examples above each GraphQL example so readers can copy the form that matches their layer.Also fixes a stale
eq→equalToin the GraphQL examples (the graphile-connection-filter idiom isequalTo; this is the same fix applied to the test suite in #993).Review & Testing Checklist for Human
orm.telemedicineClinic.findMany({ where: { … } }).execute()) match your preferred documentation style — they mirror the shape used in the E2E test atgraphql/orm-test/__tests__/postgis-spatial-relations.test.tsbut the README isn't executed, so typos would go unnoticed.where:ORM block →filter:GraphQL block) read cleanly in sequence.Notes
No code changes, no new tests; CI will just run the existing suite. Zero expected behaviour change.
Link to Devin session: https://app.devin.ai/sessions/c5eeee65a3c546c4ac6753bb05fa03e0
Requested by: @pyramation