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

[CP] Update dartdoc to provide chips for class modifiers on class or mixin pages. #52208

Closed
jcollins-g opened this issue Apr 28, 2023 · 10 comments
Assignees
Labels
area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. cherry-pick-approved Label for approved cherrypick request cherry-pick-merged Cherry-pick has been merged to the stable or beta branch. cherry-pick-review Issue that need cherry pick triage to approve merge-to-stable

Comments

@jcollins-g
Copy link
Contributor

jcollins-g commented Apr 28, 2023

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

@jcollins-g jcollins-g added the cherry-pick-review Issue that need cherry pick triage to approve label Apr 28, 2023
@itsjustkevin
Copy link
Contributor

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.

@mit-mit
Copy link
Member

mit-mit commented Apr 28, 2023

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.

@mraleph mraleph added the area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. label Apr 28, 2023
@jcollins-g
Copy link
Contributor Author

@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.

@itsjustkevin
Copy link
Contributor

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 🙂

@itsjustkevin itsjustkevin added the cherry-pick-hold Hold off on this cherry-pick label May 1, 2023
@itsjustkevin
Copy link
Contributor

Hold for next stable hotfix.

@itsjustkevin
Copy link
Contributor

@mit-mit do we have the stamp of approval on this cherry-pick now that Dart 3 is released?

@itsjustkevin
Copy link
Contributor

@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.

@jcollins-g
Copy link
Contributor Author

@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.

@itsjustkevin
Copy link
Contributor

@jcollins-g I've edited the issue to point to the new cherry-pick, however there are merge conflicts.

@jcollins-g
Copy link
Contributor Author

@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.

@itsjustkevin itsjustkevin added merge-to-stable cherry-pick-approved Label for approved cherrypick request and removed cherry-pick-hold Hold off on this cherry-pick labels May 15, 2023
copybara-service bot pushed a commit that referenced this issue May 22, 2023
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]>
@itsjustkevin itsjustkevin added the cherry-pick-merged Cherry-pick has been merged to the stable or beta branch. label May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-infrastructure Use area-infrastructure for SDK infrastructure issues, like continuous integration bot changes. cherry-pick-approved Label for approved cherrypick request cherry-pick-merged Cherry-pick has been merged to the stable or beta branch. cherry-pick-review Issue that need cherry pick triage to approve merge-to-stable
Projects
None yet
Development

No branches or pull requests

7 participants