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]: Updating nullable signatures #3

Open
1 task done
Zeegaan opened this issue Jun 24, 2022 · 0 comments
Open
1 task done

[Breaking change]: Updating nullable signatures #3

Zeegaan opened this issue Jun 24, 2022 · 0 comments
Labels
category/source-incompatible Source code may encounter a breaking change in behavior when targeting the new version. cms/release/11.0.0 cms/release/12.0.0 cms/release/13.0.0

Comments

@Zeegaan
Copy link
Member

Zeegaan commented Jun 24, 2022

Description

In our codebase, we have found methods that have wrong nullability, and those we wish to update as soon as possible.
As these are not binary breaking changes, but only source breaking changes we will change those between majors, especially to prevent people from using a non-nullable method that in theory could actually return null, and therefore break their code.

PR that makes the change: N/A

Version

Umbraco 11.0.0-rc1

Previous behaviour

Some methods return non-nullable that can actually be null.
Some methods return nullable that cannot be null.

New behaviour

Some methods return non-nullable that can not be null.
Some methods return nullable that can be null.

Type of breaking change

  • Source incompatible: Source code may encounter a breaking change in behaviour when targeting the new runtime/component/SDK, such as compile errors or different run-time behaviour.

Reason for change

We want to prevent peoples code from blowing up if they use a non-nullable method in their codebase, and to stop redundant null-checks if they are using a nullable method that can never be null

Recommended action

If you are using a method with a wrong signature, please move to the correct signature instead

Affected APIs

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category/source-incompatible Source code may encounter a breaking change in behavior when targeting the new version. cms/release/11.0.0 cms/release/12.0.0 cms/release/13.0.0
Projects
None yet
Development

No branches or pull requests

2 participants