Fix SpatialPipeline with_predicate docs #638
Merged
Conversation
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
Jondolf
reviewed
Jan 23, 2025
Member
Jondolf
left a comment
Jondolf
left a comment
There was a problem hiding this comment.
Thanks, yeah I think the docs for the predicates are currently wrong. I'm pretty sure the old callback docs are correct though.
Jondolf
added
C-Docs
Contributor
Author
Oh I see; I didn't test for callback but I assumed they were also inverted; will fix |
cBournhonesque
force-pushed
the
cb/fix-cast-ray-docs
branch
from
03efebe to
cb41784
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Objective
The docs say that the ray/shape casts will stop on the first instance where the predicate returns false, but it seems like the opposite is the case.
Maybe it would be good to add a unit test to confirm this.