PedestrianDynamics / PedestrianDynamics/PedPy
Deprecate blind point parameter in Voronoi compuation
Nobody has claimed this yet.
- Dominant language
- Pascal
- Stars
- 35
- Forks
- 18
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 2
Description
Summary
Mark the use_blind_points parameter in compute_individual_voronoi_polygons as officially deprecated, clean up all test usages, and ensure a DeprecationWarning is emitted when the parameter is passed.
Background / Context
use_blind_points has no effect on the computation and was kept for backwards compatibility. It is already documented as deprecated in the docstring, but the deprecation is not consistently enforced across the codebase — reference tests still pass it without expecting a warning.
Technical Details
- Parameter lives in
pedpy/methods/method_utils.py— deprecation warning already emitted when the parameter is notNone - Reference tests in
tests/reference_tests/reference_test.pystill passuse_blind_pointswithoutpytest.warns - Existing deprecation warning unit tests in
tests/unit_tests/methods/test_compute_individual_voronoi_polygons.py
Acceptance Criteria
- Passing
use_blind_points(any value) emits aDeprecationWarning - A test verifies that passing the parameter yields a
DeprecationWarning - All tests specific to
use_blind_pointsbehavior are removed - Reference tests no longer pass
use_blind_points - Reference data for verifying
use_blind_pointsare removed
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in pedpy/methods/method_utils.py, then inspect the existing deprecation tests in tests/unit_tests/methods/test_compute_individual_voronoi_polygons.py and the usages in tests/reference_tests/reference_test.py. Run the relevant tests first. Done means passing the parameter is covered by a DeprecationWarning test, obsolete behavior tests and reference data are removed, and reference tests no longer pass use_blind_points.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing-qa
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100