-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
[CP] Update dartdoc to provide chips for class modifiers on class or mixin pages. #52208
Comments
Requesting another look from @mit-mit as this is a usability issue. Requesting a look from @vsmenon and @leafpetersen to verify if this meets the bar for a cherry-pick late into the cycle. |
I think this meets the bar in terms of user impact -- it's a significant gap for a new feature in the release. I can't access if the risk is sufficient low though, and will leave that as an engineering decision. |
@mit-mit @itsjustkevin Ping to elevate this cherry pick. The equivalent for Flutter (flutter/flutter#125661) has already merged; it would be unfortunate if this one didn't make it. |
This hasn't been lost in the ocean @jcollins-g, we will be reviewing the cherry-picks today, will report back the status on the issue later in the day 🙂 |
Hold for next stable hotfix. |
@mit-mit do we have the stamp of approval on this cherry-pick now that Dart 3 is released? |
@jcollins-g could you rebase this against the stable branch? Seeing the results would make it easier to verify the safety of this cherry-pick. |
@itsjustkevin https://dart-review.googlesource.com/c/sdk/+/302841 is the rebased change. The delta is exactly the same, though of course the context of other DEPS changes may be different. |
@jcollins-g I've edited the issue to point to the new cherry-pick, however there are merge conflicts. |
@itsjustkevin I apologize, my git-fu is not very strong apparently. I have attempted once again to rebase and have restarted the bots. Will keep an eye on it. |
Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v6.2.2 Bug: #52208 Cherry-pick: https://dart-review.googlesource.com/c/sdk/+/299340 Change-Id: I944c3db93b3375cce1eefd99425055b1d0fc8375 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/302841 Commit-Queue: Janice Collins <[email protected]> Reviewed-by: Konstantin Shcheglov <[email protected]>
Commit(s) to merge
f193d91
Target
beta
Prepared changelist for beta/stable
https://dart-review.googlesource.com/c/sdk/+/302841
Issue Description
The motivating issue is that it is hard to see class modifiers on dartdoc generated pages, here: dart-lang/dartdoc#3392.
What is the fix
https://github.com/dart-lang/dartdoc/pulls/3401 is the fix, to add chips to the top of class and mixin pages to indicate class modifiers, show a small tooltip, and link to descriptive documentation.
Why cherry-pick
Users may miss that class modifiers apply to a part of a Dart API without this change, as the old way of displaying them in the breadcrumb is easy to miss. As class modifiers are a core feature of Dart 3.0 it makes sense to have them show up prominently in documentation. @mit-mit requested that we make an effort to get this in for the initial release.
Risk
low
Issue link(s)
dart-lang/dartdoc#3392
Extra Info
This cherry pick pulls in all deltas for dartdoc, including one other bugfix and some housekeeping.
Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v6.2.2
Github diff between dartdoc revisions: https://github.com/dart-lang/dartdoc/compare/1a7952b..d01ddc5
The text was updated successfully, but these errors were encountered: