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

Version 3.0.1+1 #689

Merged
merged 1 commit into from Oct 15, 2021
Merged

Conversation

cbracken
Copy link
Member

@cbracken cbracken commented Oct 14, 2021

This version adds a minor documentation change.

With non-null by default implemented as of Dart 2.12, developers should
avoid adding more uses of the Optional type in there code, and ideally
start migrating existing uses to nullable types.

Not marking this as deprecated yet, since not all users have migrated
their codebases to NNBD, and migration off this type has some tricky
edge-cases.

Related: #679
Related: #672 (deprecate optional)

@cbracken cbracken requested a review from yjbanov October 14, 2021 22:50
@google-cla google-cla bot added the cla: yes @googlebot is happy with the CLA status of this PR label Oct 14, 2021
@cbracken cbracken added documentation and removed cla: yes @googlebot is happy with the CLA status of this PR labels Oct 14, 2021
@google-cla google-cla bot added the cla: yes @googlebot is happy with the CLA status of this PR label Oct 14, 2021
Copy link
Member

@yjbanov yjbanov left a comment

Choose a reason for hiding this comment

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

lgtm

This version adds a minor documentation change.

With non-null by default implemented as of Dart 2.12, developers should
avoid adding more uses of the Optional type in there code, and ideally
start migrating existing uses to nullable types.

Not marking this as deprecated yet, since not all users have migrated
their codebases to NNBD, and migration off this type has some tricky
edge-cases.
@cbracken cbracken merged commit eb643e6 into google:master Oct 15, 2021
@cbracken cbracken deleted the add-warning-about-optional branch October 15, 2021 04:59
@@ -1,3 +1,9 @@
#### 3.0.1+1 - 2021-10-14
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

@cbracken cbracken Jan 4, 2022

Choose a reason for hiding this comment

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

Oh weird. TIL!

Out of curiosity, when did this rule change? We'd been doing this for years for "no functional effect" changes like documentation, as had other packages like vm_service, dart_style, async, etc. Might be worth sending out a note to the dart/flutter teams.

Copy link
Member

Choose a reason for hiding this comment

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

There was a bunch of confusion years ago about the intended patterns. Some packages only used +1 version changes for 0.x releases, while other packages kept using them after the 1.x release for doc changes.

Copy link
Member Author

Choose a reason for hiding this comment

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

SGTM - glad we've got a clearly documented policy now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes @googlebot is happy with the CLA status of this PR documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants