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

Remove underscores #192

Merged
merged 8 commits into from
Jun 10, 2022

Conversation

Saransh-cpp
Copy link
Member

@Saransh-cpp Saransh-cpp commented May 21, 2022

Closes #136

Underscores removed

  • object_ -> object
  • awkward_ -> awkward
  • numpy_ -> numpy
  • numba_ -> numba
  • _backends -> backends

@Saransh-cpp Saransh-cpp requested review from jpivarski and henryiii June 8, 2022 09:13
@Saransh-cpp
Copy link
Member Author

Is there a file where I should add a warning for this? The issue mentions that the _backends package is being used outside of vector; would this be a breaking change?

@jpivarski
Copy link
Member

The issue says that interfaces in the backends package could be used by third-party developers in the future, and _backendsbackends makes it possible for them to start doing that. This API change adds a new publicly visible module, so it can't break any legitimate dependencies (only illegitimate ones that were directly looking inside of _backends), so it's safe.

However, it would be worthwhile checking inside backends to see if there's anything in there that would be bad to make public (i.e. to let people legitimately depend on the current interfaces).

Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the modules in backends that I could see make good use of leading underscores for private implementations, except for the numba and numba_object backends. So just make these

  • backends/numbabackends/_numba
  • backends/numba_objectsbackends/_numba_objects

and that should be it. 100% of the Numba code is registering things in Numba itself: the variables and functions that are left around after doing that are of no interest to third-party developers and should be hidden so that we're free to change them.

@Saransh-cpp
Copy link
Member Author

Thank you for the review! Yes, the numba part makes sense. I will update the underscores!

@Saransh-cpp Saransh-cpp requested a review from jpivarski June 8, 2022 18:20
@Saransh-cpp Saransh-cpp force-pushed the issue-136/remove-underscores branch from 4b93108 to 52d333c Compare June 10, 2022 15:18
@Saransh-cpp Saransh-cpp merged commit 5387e5e into scikit-hep:main Jun 10, 2022
@Saransh-cpp Saransh-cpp deleted the issue-136/remove-underscores branch June 10, 2022 15:26
@Saransh-cpp Saransh-cpp added this to the v0.9.0 milestone Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove underscores from module names
2 participants