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

breaking change: deprecate cnb_classification dataset #329

Open
jdhoffa opened this issue Feb 7, 2024 · 8 comments
Open

breaking change: deprecate cnb_classification dataset #329

jdhoffa opened this issue Feb 7, 2024 · 8 comments
Labels
ADO Add issue to ADO breaking change ☠️ API change likely to affect existing code feature a feature request or enhancement

Comments

@jdhoffa
Copy link
Member

jdhoffa commented Feb 7, 2024

Relates to #327

FYI @jacobvjk, I plan to deprecate these datasets properly, which means including a release where we just warn that they will be deprecated.

AB#10173

@AlexAxthelm
Copy link
Contributor

@jdhoffa do we have a rough timeframe (on a calendar) when we expect to fully deprecate?

@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 8, 2024

Nope, but I think if we do my quarterly release schedule, then next release is end of Q1 (end of March). That will mark beginning of deprecation.

Following release is end of Q2 (so end of June?)

I guess end of June would be when they are hard deprecated? I will update the warning message and add an ADO ticket

@AlexAxthelm
Copy link
Contributor

Maybe have something along the lines of

"foo will be available until 2024-06-01. In releases of r2dii.data after that date, it will be unavailable. Please use bar instead. See this blog post for more information."

So users know have some idea of when they would need to transition by?

@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 8, 2024

Deprecation warning is already there. Following the lifecycle style deprecation process:
https://github.com/RMI-PACTA/r2dii.data/pull/331/files

I just need to update the "date"

@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 8, 2024

@AlexAxthelm do you think "expected in 2024Q2 release" would be too vague actually? I would tend to prefer that... especially given that the proposed "quarterly release" cadence is really just quarterly and has no specific date or month focus yet...

Gives us a bit of flexibility while still giving the user an idea of when things will change.

@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 8, 2024

ADO ticket in proposal of next quarter's KRs involving completing the deprecation process:
https://dev.azure.com/RMI-PACTA/2DegreesInvesting/_workitems/edit/9711

@AlexAxthelm
Copy link
Contributor

"expected in 2024Q2 release" would be too vague actually?

I think I shouldn't write user-facing messages. But that's reasonable enough from my side.

cc @hodie

@jdhoffa
Copy link
Member Author

jdhoffa commented Mar 6, 2024

As per a discussion with @jacobvjk, we are going to add the ISIC classification bridge revision 5. So rather than a "deprecation" the dataset will just be updated.

See here: https://unstats.un.org/unsd/classifications/Econ

cnb_classification will still be deprecated

@jdhoffa jdhoffa removed the ADO Add issue to ADO label Mar 6, 2024
@jdhoffa jdhoffa changed the title Deprecate datasets cnb_classification and isic_classification breaking change: deprecate cnb_classification dataset Mar 6, 2024
@jdhoffa jdhoffa added the ADO Add issue to ADO label Mar 6, 2024
@jdhoffa jdhoffa removed their assignment Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ADO Add issue to ADO breaking change ☠️ API change likely to affect existing code feature a feature request or enhancement
Projects
None yet
Development

No branches or pull requests

2 participants