Skip to content

Fix SpatialPipeline with_predicate docs#638

Merged
Jondolf merged 1 commit into
avianphysics:mainfrom
cBournhonesque:cb/fix-cast-ray-docs
Jan 24, 2025
Merged

Fix SpatialPipeline with_predicate docs#638
Jondolf merged 1 commit into
avianphysics:mainfrom
cBournhonesque:cb/fix-cast-ray-docs

Conversation

@cBournhonesque

Copy link
Copy Markdown
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.

@Jondolf Jondolf left a comment

Copy link
Copy Markdown
Member

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.

Comment thread src/spatial_query/pipeline.rs Outdated
Comment thread src/spatial_query/pipeline.rs Outdated
Comment thread src/spatial_query/pipeline.rs Outdated
Comment thread src/spatial_query/pipeline.rs Outdated
Comment thread src/spatial_query/pipeline.rs Outdated
@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
Copy Markdown
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

@Jondolf Jondolf left a comment

Copy link
Copy Markdown
Member

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 avianphysics:main Jan 24, 2025
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