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

[Dart 3] Document general use of class modifier by Dart core libraries in Library Tour #4730

Open
parlough opened this issue Mar 31, 2023 · 8 comments
Labels
a.libraries Relating to the Dart standard libraries. co.request Community ask for documentation e1-hours Can complete in < 8 hours of normal, not dedicated, work from.team Reported by Dash docs team member p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@parlough
Copy link
Member

A lot of Dart core libraries are introducing usage of class modifiers to limit various uses of them (extending, implementing, mixing in, etc). We should make users aware of this somehow, likely when introducing the core libraries themselves. It can link to other class modifier docs if necessary.

@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 co.request Community ask for documentation labels Mar 31, 2023
@parlough parlough changed the title [Dart 3] Document general use of class modifier by core Dart libraries [Dart 3] Document general use of class modifier by Dart core libraries Mar 31, 2023
@atsansone atsansone added this to the Next Major Release milestone Apr 4, 2023
@MaryaBelanger
Copy link
Contributor

I think the communication plan for all of the Dart 3 migration / breaking changes info is to add a "Dart 3 migration" page to dart.dev somewhere. I've added notes about this to the planning doc for that communication and am waiting to see if others think it fits.

I'm not sure who's in charge of creating that content though, will update.

@parlough
Copy link
Member Author

parlough commented Apr 10, 2023

That sounds good, thanks.

I however still see value in educating users of the possibility of these limitations, whether they are migrating or not, while they approach core library usage.

@MaryaBelanger
Copy link
Contributor

MaryaBelanger commented Apr 12, 2023

List of affected APIs per library from the changelog:

Possibly also relevant / should be called out: Existing classes that have been made mixin classes

@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Apr 12, 2023
@MaryaBelanger
Copy link
Contributor

Note: the migration guide summarizes this a little (not a replacement for documenting in the library tour)

@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. and removed p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. labels May 10, 2023
@MaryaBelanger
Copy link
Contributor

3.1.0 library changes dues to class modifiers:

@parlough
Copy link
Member Author

Thanks for calling attention to that, looks like it was part of the 3.0.3 release. I opened a PR adding them to the migration guide - #5075

@MaryaBelanger
Copy link
Contributor

@parlough Thanks for adding those 3.0.3 changes to the migration guide. Just want to re-confirm: you still think those and all the other core library changes should be documented in their sections in the Library Tour, correct?

I'm updating the title of this issue since documenting them in the migration guide could be misconstrued as solving the title as written, but lmk if you're thinking differently!

@MaryaBelanger MaryaBelanger changed the title [Dart 3] Document general use of class modifier by Dart core libraries [Dart 3] Document general use of class modifier by Dart core libraries in Library Tour Jul 24, 2023
@parlough
Copy link
Member Author

parlough commented Jul 24, 2023

Thanks for updating that.

My thinking still is just adding a brief mention to the top or intro that it is something developers may come across when using built-in Dart APIs. Perhaps it will be less useful over time as users learn about class modifiers, but just want learners to be at least a little familiar before they come across related diagnostic messages.

Maybe it's not necessary with the diagnostic messages, but I feel it wouldn't hurt to prepare them for that. What do you think?

@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. co.request Community ask for documentation e1-hours Can complete in < 8 hours of normal, not dedicated, work from.team Reported by Dash docs team member p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

3 participants