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

Doc example incorrect and misleading #374

Closed
iOSonntag opened this issue Apr 21, 2024 · 3 comments
Closed

Doc example incorrect and misleading #374

iOSonntag opened this issue Apr 21, 2024 · 3 comments

Comments

@iOSonntag
Copy link
Contributor

iOSonntag commented Apr 21, 2024

Hey folks, GREAT JOB on ElectroDB absolutely dope what you have build!!

Just a quick note on one doc example I found to be misleading. In the ConditionExpression section under examples here in the "dynamic" filtering example is a logical issue (I think).

As I understood the framework, chained where clauses lead to implicit ANDs and if thats the case then the example will never ever return any item. That is because it tries to find an item where the keeper attribute is two different values at the same time (pratically impossible).

My suggestion would be to update the example to use OR instead, but I am not sure how to do this in order for the example to still contain that for loop. That is why I have not edited the page.

@tywalch
Copy link
Owner

tywalch commented May 1, 2024

Great catch! I usually accept and merge pretty much any documentation PRs; I'm not very opinionated about how an inaccurate example would be changed, so if you wanted to remove the loop entirely (for example) I'd be totally fine with that. If you'd like to make a PR I'd stamp it, otherwise I'll note this for my next documentation commit!

@iOSonntag
Copy link
Contributor Author

@tywalch Alright I just reversed the condition to not equal ne() that should do the trick I guess. Pull request #379

@iOSonntag
Copy link
Contributor Author

iOSonntag commented May 23, 2024

Closed with merge of #379

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

No branches or pull requests

2 participants