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

Fix SpatialPipeline with_predicate docs #638

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

cBournhonesque
Copy link
Contributor

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.

Copy link
Owner

@Jondolf Jondolf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, yeah I think the docs for the predicates are currently wrong. I'm pretty sure the old callback docs are correct though.

src/spatial_query/pipeline.rs Outdated Show resolved Hide resolved
src/spatial_query/pipeline.rs Outdated Show resolved Hide resolved
src/spatial_query/pipeline.rs Outdated Show resolved Hide resolved
src/spatial_query/pipeline.rs Outdated Show resolved Hide resolved
src/spatial_query/pipeline.rs Outdated Show resolved Hide resolved
@Jondolf Jondolf added C-Docs Improvements or additions to documentation A-Spatial-Query Relates to spatial queries, such as ray casting, shape casting, and intersection tests labels Jan 23, 2025
@cBournhonesque
Copy link
Contributor Author

Thanks, yeah I think the docs for the predicates are currently wrong. I'm pretty sure the old callback docs are correct though.

Oh I see; I didn't test for callback but I assumed they were also inverted; will fix

Copy link
Owner

@Jondolf Jondolf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@Jondolf Jondolf merged commit a1853b7 into Jondolf:main Jan 24, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Spatial-Query Relates to spatial queries, such as ray casting, shape casting, and intersection tests C-Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants