docs(postgrest): Expand documentation for contains and containedBy methods
#824
Conversation
Previous documentation provides code examples that are syntactically incorrect and do not explain how to provide inclusive and exclusive ranges as a value.
jocubeit
changed the title
jocubeit
changed the title
jocubeit
changed the title
There was a problem hiding this comment.
Thanks for this. This PR is great. Just to take this PR a step further, maybe we can address the different data types that contains and containedBy can be used against. Both of these filters can be used against an array and range types (and json types with array). Maybe it's better to explain this and
The JS docs explains it well, and yes, will bring this over to the Flutter docs as well.
https://supabase.com/docs/reference/javascript/containedby?example=on-jsonb-columns
I think we can add an example in each method to show how to use them with array columns.
And then for the range example, I actually like the [1,2) sample that we currently have, because it shows that you can use inclusive and exclusive range in a single call. Maybe we can just say something like use "use brackets for inclusive range and parenthesis for exclusive range", and just have the current example that we have.
| /// await supabase | ||
| /// .from('users') | ||
| /// .select() | ||
| /// .contains('age_range', '[1,2]'); |
There was a problem hiding this comment.
I'm guessing this chunk is a typo since we have the same thing just above.
| /// await supabase | ||
| /// .from('users') | ||
| /// .select() | ||
| /// .containedBy('age_range', '[1,2]'); |
There was a problem hiding this comment.
And this one seems like a duplicate as well.
|
I have updated the docs on |
dshukertjr
changed the title
contains and containedBy methods
dshukertjr
changed the title
contains and containedBy methodscontains and containedBy methods
There was a problem hiding this comment.
I made some edits based on the examples provided in the docs. Thanks for the PR!
What kind of change does this PR introduce?
Previous documentation provides code examples that are syntactically incorrect and do not explain how to provide inclusive and exclusive ranges as a value.
This PR does not introduce any code changes, only code documentation changes.
Additional context
Documentation in VS Code for
containsandcontainedBymethods was confusing, and looked like an obvious typo. While performing a deeper dive into the methods themselves I discovered I could pass a string with parenthesis or brackets, or an array object as a value. This was not exposed in the code comments for the documentation. I felt compelled to update it.