Skip to content

Implement the Q1 2021 small features release in dartdoc. #44922

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

Closed
3 tasks done
leafpetersen opened this issue Feb 9, 2021 · 17 comments
Closed
3 tasks done

Implement the Q1 2021 small features release in dartdoc. #44922

leafpetersen opened this issue Feb 9, 2021 · 17 comments
Assignees
Labels
area-tools A meta category for issues that should be addressed by tooling (prefer more concrete areas). P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug

Comments

@leafpetersen
Copy link
Member

leafpetersen commented Feb 9, 2021

This tracks implementation work for this feature set.

cc @devoncarew @jcollins-g @franklinyow

Individual feature tracking:

@leafpetersen
Copy link
Member Author

@jcollins-g any updates here?

@jcollins-g
Copy link
Contributor

This work is just starting.

@franklinyow franklinyow added the P2 A bug or feature request we're likely to work on label Mar 29, 2021
@devoncarew devoncarew added area-tools A meta category for issues that should be addressed by tooling (prefer more concrete areas). and removed area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. labels Mar 30, 2021
@jcollins-g
Copy link
Contributor

This is unlikely to be complete within one week; at most, code will be landed for 1 or 2 out of three by this point.

@devoncarew
Copy link
Member

@leafpetersen - do you have a sense for in which order we should tackle these in?

@leafpetersen
Copy link
Member Author

What's the existing status for each of them? That is, does dartdoc crash, or just generate sub-optimal docs or something else? It looks like unsigned shift is documented on int now, but the link doesn't work? How about the rest?

@devoncarew
Copy link
Member

dartdoc support is still in progress; generally:

  • generic functions as type arguments does not crash but isn't yet fully functional
  • generic-metadata support seems to be "fine" on first inspection and does not crash; some bits landing now will help it approach something more stable
  • triple shift seems to be fine; we're less worried here

@jcollins-g
Copy link
Contributor

dartdoc support is still in progress; generally:

  • generic functions as type arguments does not crash but isn't yet fully functional
  • generic-metadata support seems to be "fine" on first inspection and does not crash; some bits landing now will help it approach something more stable

This assumes we get another analyzer publish on time; currently published analyzer does crash here.

  • triple shift seems to be fine; we're less worried here

@leafpetersen
Copy link
Member Author

Tentatively marking triple shift and generic metadata as done since the linked bugs have been closed, any remaining work on those two?

@jcollins-g
Copy link
Contributor

Yes. dartdoc must be published and rolled through the ecosystem (working on that today). The analyzer must also be published.

@jcollins-g
Copy link
Contributor

jcollins-g commented Apr 5, 2021

The urgency on this has decreased somewhat, but here are the CLs for the SDK and flutter. The first two checkmarks can be considered "done" at the point these land (edit: and the analyzer is published).
https://dart-review.googlesource.com/c/sdk/+/194011 : CL for dartdoc in SDK
flutter/flutter#79795 : CL for dartdoc in flutter

@franklinyow franklinyow added the type-enhancement A request for a change that isn't a bug label Apr 20, 2021
@leafpetersen
Copy link
Member Author

Any updates? FYI, the flag flip CLs have now landed in master (this doesn't affect the timing of this issue, just FYI).

@jcollins-g
Copy link
Contributor

dart-lang/dartdoc#2625 brings dartdoc back to where it was before the feature was punted out. No further updates for now.

@franklinyow
Copy link
Contributor

Any update?

@jcollins-g
Copy link
Contributor

I'll look into this this week; remaining work is expected to be small.

@franklinyow
Copy link
Contributor

@leafpetersen Looks like the last pieces is done. Ready to close this?

@jcollins-g
Copy link
Contributor

@franklinyow The change just landed inside Dartdoc; I would prefer it to propagate to the Dart SDK and Flutter before closing this issue. That will likely happen Monday.

@jcollins-g
Copy link
Contributor

Going to close this as it looks likely that Flutter will finish landing shortly. Small features is done for dartdoc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-tools A meta category for issues that should be addressed by tooling (prefer more concrete areas). P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

4 participants