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

[2.19] Deprecated APIs #4249

Closed
12 tasks done
MaryaBelanger opened this issue Sep 29, 2022 · 4 comments
Closed
12 tasks done

[2.19] Deprecated APIs #4249

MaryaBelanger opened this issue Sep 29, 2022 · 4 comments
Assignees
Labels
a.libraries Relating to the Dart standard libraries. e1-hours Can complete in < 8 hours of normal, not dedicated, work from.team Reported by Dash docs team member meta.evaluation Need to consider what changes if any are needed p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.

Comments

@MaryaBelanger
Copy link
Contributor

MaryaBelanger commented Sep 29, 2022

This is an evaluation ticket

Evaluating the possible need for doc updates due to dart-lang/sdk#34233

Summary

APIs deprecated in previous releases are fully removed now.

Evaluation

Search dart.dev for all the APIs mentioned in the change log, (unlikely any are mentioned in the docs)
Correct to new recommended option if available :

  • MirrorsUsed and Comment
  • kInvalidParams
  • kExtensionError
  • kExtensionErrorMax
  • kExtensionErrorMin in ServiceExtensionResponse
  • DEFAULT_BUFFER_SIZE in JsonUtf8Encoder
  • Deprecated in 2.19: UserTag.MAX_USER_TAGS
  • FallThroughError
  • registerElement and registerElement2 in Document and HtmlDocument
  • NullThrownError and CyclicInitializationError
  • IndexError constructor in favor of IndexError.withLength
  • RangeError.checkValidIndex in favor of IndexError.check

References

see changelog for details, replacements, etc.

@MaryaBelanger MaryaBelanger added this to the Next stable release milestone Sep 29, 2022
@MaryaBelanger MaryaBelanger added the meta.evaluation Need to consider what changes if any are needed label Sep 29, 2022
@MaryaBelanger MaryaBelanger self-assigned this Sep 29, 2022
@sfshaza2
Copy link
Collaborator

On the Flutter website, we capture this sort of info in the breaking changes section of the website. I'm not sure if you have that on Dart, do you?

@parlough parlough added a.libraries Relating to the Dart standard libraries. p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e1-hours Can complete in < 8 hours of normal, not dedicated, work labels Sep 29, 2022
@parlough
Copy link
Member

parlough commented Sep 29, 2022

We don't currently track SDK release notes or breaking changes outside of language evolution and a link to the blog on the site's "What's new page". Might be useful to introduce a similar page to Flutter's.

As for the deprecations and removals here, you're right that we unlikely use any of these, but thanks for checking!

@MaryaBelanger
Copy link
Contributor Author

Thanks for the insight @sfshaza2! Yeah, like @parlough said this is just to check the regular docs to make sure none of these are mentioned in any of the long-form content (guides, tutorials, troubleshooting, etc.); these changes are all documented in the change log already.

Flutter breaking changes (for my reference)

Might be useful to introduce a similar page to Flutter's

Possibly, not sure how to gauge the usefulness of that but I could make another issue and see what the team thinks

@MaryaBelanger
Copy link
Contributor Author

As expected, nothing in the docs (except the spec I think, but I know that lags behind). Closing!

@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.libraries Relating to the Dart standard libraries. e1-hours Can complete in < 8 hours of normal, not dedicated, work from.team Reported by Dash docs team member meta.evaluation Need to consider what changes if any are needed p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.
Projects
None yet
Development

No branches or pull requests

4 participants