[BUG]: Wrong docstring in simulate_physics_and_fix_final_poses
- Dominant language
- Python
- Stars
- 3.7k
- Forks
- 518
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the bug**
The method `simulate_physics_and_fix_final_poses` has a wrong docstring for the parameter `object_stopped_location_threshold` (it has the same description has `object_stopped_rotation_threshold`). The same problem appears in `simulate_physics`, in `_do_simulation` and in `_have_objects_stopped_moving`. All these methods are in `blenderproc/python/object/PhysicsSimulation.py`.
Now it is:
```
The maximum difference per second and per coordinate in the rotation Euler vector that is allowed. such that an object is still recognized as 'stopped moving'
```
It should be something like:
```
The maximum difference per second and per coordinate in the translation vector that is allowed. Such that an object is still recognized as 'stopped moving'
```
Also the word `such` should be capitalized both in `object_stopped_location_threshold` and in `object_stopped_rotation_threshold`.
Contributor guide
Research direction
Open blenderproc/python/object/PhysicsSimulation.py and inspect the docstrings for simulate_physics_and_fix_final_poses, simulate_physics, _do_simulation, and _have_objects_stopped_moving. Correct the location-threshold description to refer to translation, capitalize “Such” in both threshold descriptions, and verify all four methods use the intended wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- blender, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100