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

Renaming Database3 to Database, but preserving the API #1961

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

john-science
Copy link
Member

What is the change?

Here I rename Database3 to Database everywhere in ARMI.

However, I preserve the old Database3 end point, as a temporary measure, so this PR is full backward compatible.

Why is the change being made?

This PR makes progress on: #1673

But this PR will not close that issue, because I preserve the old database3.Database3 API end point. This is a temporary measure to ensure backwards compatibility in projects downstream.

The goal is to give downstream projects time to make the change.


Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

@john-science john-science added the cleanup Code/comment cleanup: Low Priority label Oct 18, 2024
@john-science
Copy link
Member Author

john-science commented Oct 18, 2024

@opotowsky This is another change that is fully backwards compatible and won't require any downstream changes yet. It provides time for downstream projects to conform.

But last time I tried this it required somewhat more finesse than I expected, so perhaps we should talk offline to make sure I do all my i's and cross all my t's?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code/comment cleanup: Low Priority
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant