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

contact_pair.has_any_active_contact() should be contact_pair.has_any_active_contacts() in the documentation? #101

Closed
Carter0 opened this issue Jun 18, 2022 · 3 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation M-Bevy about bevy_rapier crate P-High High Priority S-in-progress Work has been started

Comments

@Carter0
Copy link

Carter0 commented Jun 18, 2022

I'm on bevy_rapier_2d 13.1, and it wouldn't let me compile the program without making that method plural. The documentation on the website has it as "contact_pair.has_any_active_contact()". Also, the documentation in the rust docs doesn't mention that function at all, but does mention something called ContactPair::has_any_active_collider, which I am not sure exists?

@Vrixyz Vrixyz transferred this issue from dimforge/bevy_rapier May 24, 2024
@Vrixyz
Copy link
Contributor

Vrixyz commented May 24, 2024

Thanks for the report, its seems to still be the case 🤔 ; a broken doc for 2 years is a good case for #99 !

@Vrixyz Vrixyz added bug Something isn't working documentation Improvements or additions to documentation S-in-progress Work has been started P-High High Priority M-Bevy about bevy_rapier crate labels May 24, 2024
@Vrixyz
Copy link
Contributor

Vrixyz commented Jun 4, 2024

bevy side was fixed in #99 ; I'm working on fixing rust side now

@Vrixyz
Copy link
Contributor

Vrixyz commented Jun 6, 2024

there is a shared part in the text, which prompts me to unify the api rather than fixing the docs: dimforge/bevy_rapier#519 ; this will require a modification on the documentation for next release.

In the meanwhile, there is still an incorrect reference to contact_pair.has_any_active_contact() for current bevy version, that will be correct for next version, so I'll just wait it out.

@Vrixyz Vrixyz closed this as completed Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation M-Bevy about bevy_rapier crate P-High High Priority S-in-progress Work has been started
Projects
None yet
Development

No branches or pull requests

2 participants