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

Release notes about SectionDisplayDriver breaking changes #15792

Merged
merged 4 commits into from
Apr 22, 2024

Conversation

Skrypt
Copy link
Contributor

@Skrypt Skrypt commented Apr 19, 2024

@Piedone Piedone changed the title Update Release not readme Release notes about SectionDisplayDriver breaking changes Apr 19, 2024
@Piedone
Copy link
Member

Piedone commented Apr 19, 2024

Related to #15488.

src/docs/releases/1.9.0.md Outdated Show resolved Hide resolved
src/docs/releases/1.9.0.md Outdated Show resolved Hide resolved
@MikeAlhayek
Copy link
Member

I thought you have added obsolete attribute to avoid this unnecessary breaking change. Having obsolete attribute to the old methods will guide users on how to upgrade without breaking their code.

@Skrypt
Copy link
Contributor Author

Skrypt commented Apr 19, 2024

From what I understood in yesterday meeting it was not necessary as it needs to be changed anyway. It will lead into needing to do the exact same change for everyone.

@MikeAlhayek
Copy link
Member

We'll now, you'll get a compile time error and if you have a 3rd party package that depends on OC 1.x then your 3rd party library will throw an exception and prevents you from being able to upgrade until the 3rd party library offers an update too.

But if you mark the old methods obsolete, then the code will at least work as before without crashing. you can upgrade your project with no issues.

Copy link
Member

@MikeAlhayek MikeAlhayek left a comment

Choose a reason for hiding this comment

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

I don't think we should introduce this breaking change. We should obsolete the old methods for now.

src/docs/releases/1.9.0.md Outdated Show resolved Hide resolved
src/docs/releases/1.9.0.md Outdated Show resolved Hide resolved
@MikeAlhayek MikeAlhayek merged commit 8ddffff into main Apr 22, 2024
6 checks passed
@MikeAlhayek MikeAlhayek deleted the skrypt/release-note branch April 22, 2024 22:41
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.

3 participants