Skip to content

Update dartdoc to 1.0.0 #85549

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

Merged
merged 1 commit into from
Jun 29, 2021
Merged

Conversation

jcollins-g
Copy link
Contributor

This includes some major internal changes that should improve performance (the AOT template compiler) and the new lookup code. The big changes noticeable for Flutter will be resolution of field formal parameters, extension method support, and more consistent disambiguation in comment reference lookups.

While a vast net improvement, this PR will change a few links to point to the wrong place. #85484 will address that after this lands, as there was no good way to specify what the user wanted unambiguously before dartdoc 1.0.0 in a few cases. That PR includes more details on the introduced regressions and link changes.

Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v1.0.0

@flutter-dashboard flutter-dashboard bot added the c: contributor-productivity Team-specific productivity, code health, technical debt. label Jun 29, 2021
@google-cla google-cla bot added the cla: yes label Jun 29, 2021
@jcollins-g jcollins-g requested a review from gspencergoog June 29, 2021 17:36
Copy link
Contributor

@gspencergoog gspencergoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

Where are the disambiguation instructions/syntax documented that you're using in #85484?

@jcollins-g
Copy link
Contributor Author

jcollins-g commented Jun 29, 2021

32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

Where are the disambiguation instructions/syntax documented that you're using in #85484?

Sadly I plan to write the full specification now that the new lookup code is complete, which was kind of necessary as the old lookup code was many years of adhockery. I promise to send a copy.

The design notes I wrote up at the start of the new lookup code project are at https://docs.google.com/document/d/11Vzx7PjSNo55YpVEx1BBUlEUPkl6CUpHZ4gFcefBE1I/edit?resourcekey=0-xUb52CNfZwq5FLt8LWSC7A#heading=h.xgjl2srtytjt but they do not include some aspects that I discovered along the way.

@fluttergithubbot
Copy link
Contributor

This pull request is not suitable for automatic merging in its current state.

  • Please get at least one approved review before re-applying this label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@gspencergoog gspencergoog merged commit 0825f49 into flutter:master Jun 29, 2021
@jcollins-g jcollins-g deleted the dartdoc-1.0.0 branch June 29, 2021 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: contributor-productivity Team-specific productivity, code health, technical debt.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants