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

neighbours function should not return the center cell itself #17

Open
tboch opened this issue Sep 29, 2023 · 2 comments
Open

neighbours function should not return the center cell itself #17

tboch opened this issue Sep 29, 2023 · 2 comments

Comments

@tboch
Copy link
Contributor

tboch commented Sep 29, 2023

This is not really a bug, but it is surprising that a neighbours function returns by default the cell given as parameter.

@ManonMarchand
Copy link
Member

Proposition to change this:

  • rename neighbors into neighborhood and propagate to functions that depend on it
  • create a new neighbors that return the expected output

as it is an API change, we would need to first publish a warning in the next version (0.7?), and then deprecate in the version after that (0.8 or 1?). Or we do that in the 1.0.0 directly?

@ManonMarchand
Copy link
Member

Note: there is a boolean on rust side to remove center

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants