search

supabase / supabase-flutter

Flutter integration for Supabase. This package makes it simple for developers to build secure and scalable products.
https://supabase.com/
MIT License
662 stars 155 forks source link

docs(postgrest): Expand documentation for `contains` and `containedBy` methods #824

Closed jocubeit closed 4 months ago

jocubeit commented 4 months ago

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 contains and containedBy methods 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.

dshukertjr commented 4 months ago

I have updated the docs on contains and containedBy with more intuitive examples. It would be great if we could bring these examples over to the comment docs on supabase_flutter if you're interested!

https://supabase.com/docs/reference/dart/contains