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

CrimeRateUpdate class uses 'overlay' list in update function #1243

Open
ldicker83 opened this issue Aug 17, 2022 · 0 comments
Open

CrimeRateUpdate class uses 'overlay' list in update function #1243

ldicker83 opened this issue Aug 17, 2022 · 0 comments
Labels
easy A simple task that will take minimal effort to implement task Task to be completed.
Milestone

Comments

@ldicker83
Copy link
Collaborator

ldicker83 commented Aug 17, 2022

This is a bit ambiguous -- while the behavior is correct calling it an overlay list is a misnomer.

This could be done better by renaming the parameter to something making it clear that it's a list of tiles with police coverage or by providing a list of police structures and generating the tile list internally.

Primarily this is a documentation issue focused on improving possible ambiguity.

@ldicker83 ldicker83 added task Task to be completed. easy A simple task that will take minimal effort to implement labels Aug 17, 2022
@ldicker83 ldicker83 added this to the v1.0.0 milestone Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy A simple task that will take minimal effort to implement task Task to be completed.
Projects
None yet
Development

No branches or pull requests

1 participant