search

dimforge / rapier.rs

Official website for the Rapier physics engine.
https://rapier.rs
17 stars 48 forks source link

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

Closed Carter0 closed 1 month ago

Carter0 commented 2 years ago

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 commented 1 month ago

Thanks for the report, its seems to still be the case 🤔 ; a broken doc for 2 years is a good case for https://github.com/dimforge/rapier.rs/pull/99 !

Vrixyz commented 1 month ago

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

Vrixyz commented 1 month ago

there is a shared part in the text, which prompts me to unify the api rather than fixing the docs: https://github.com/dimforge/bevy_rapier/pull/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.