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

📚 Documentation: Double check queries #1353

Open
2 tasks done
stnguyen90 opened this issue Sep 18, 2024 · 5 comments
Open
2 tasks done

📚 Documentation: Double check queries #1353

stnguyen90 opened this issue Sep 18, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@stnguyen90
Copy link
Contributor

💭 Description

The syntax for some queries don't seem to match between the docs and the SDKs.

For example, the Python SDK's has Query.and_queries(), but the docs show Query.and():

image

In addition, the Swift SDK requires the value label like Query.equal("released", value: [true]), but the docs just show Query.equal("title", ["Iron Man"]):

image

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

@stnguyen90 stnguyen90 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 18, 2024
@ChiragAgg5k
Copy link

Image

@stnguyen90 regarding your first issue, it seems like only the python sdk has this discrepancy for using and_queries(), while rest all use .and() syntax. perhaps it would be better to fix this in python sdk itself?

@stnguyen90
Copy link
Contributor Author

@ChiragAgg5k, yes the Python SDK is different. We can't use and because it's reserved.

@ChiragAgg5k
Copy link

oh alrightt

@ChiragAgg5k
Copy link

I can work on the issue, can you assign it to me?

@stnguyen90
Copy link
Contributor Author

@ChiragAgg5k, assigned!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants