site-www icon indicating copy to clipboard operation
site-www copied to clipboard

[2.19] Deprecated APIs

Open MaryaBelanger opened this issue 2 years ago • 3 comments

This is an evaluation ticket

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

Summary

APIs deprecated in the previous release 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

References

see changelog for details, replacements, etc.

MaryaBelanger avatar Sep 29 '22 17:09 MaryaBelanger

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?

sfshaza2 avatar Sep 29 '22 17:09 sfshaza2

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!

parlough avatar Sep 29 '22 18:09 parlough

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 avatar Oct 04 '22 15:10 MaryaBelanger

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

MaryaBelanger avatar Nov 29 '22 21:11 MaryaBelanger