Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upUpdate dartdoc to 0.35.0 #67432
Update dartdoc to 0.35.0 #67432
Conversation
@@ -0,0 +1,3 @@ | |||
dartdoc: | |||
ignore: | |||
- no-documentable-libraries |
@@ -0,0 +1,3 @@ | |||
dartdoc: | |||
ignore: | |||
- no-documentable-libraries |
goderbauer
Oct 6, 2020
Member
Are we adding this ignore here instead of in https://github.com/flutter/flutter/blob/master/dartdoc_options.yaml so it only applies to that empty Flutter
package and nothing else?
Should https://github.com/flutter/flutter/blob/master/dartdoc_options.yaml make this warning fetal (by listing it in the error section) for all other packages?
jcollins-g
Oct 6, 2020
Author
Contributor
I don't know -- obviously something is very catastrophically wrong in Flutter, or more likely, dartdoc internals, if that happens so it seems fair to add it. I'll try it and make sure it doesn't have any adverse consequences, then follow up here.
jcollins-g
Oct 6, 2020
Author
Contributor
Oh, and yes, it is in dartdoc_options.yaml in dev/docs
to limit the scope of the setting.
jcollins-g
Oct 6, 2020
Author
Contributor
@goderbauer Added as an error in the top level dartdoc_options.yaml
; seems to work fine and there aren't any more stub packages hiding out that are impacted. PTAL.
LGTM Thank you! |
e9a9a61
into
flutter:master
Description
This PR updates the version of dartdoc used by Flutter to 0.35.0. See the release notes, below, for the complete list of changes implied by this PR. Due to dart-lang/dartdoc#2360, the stub
Flutter
package emits a warning by default because it has no libraries. Adartdoc_options.yaml
file has been added to ignore that warning.Related Issues
Dartdoc Release notes: https://github.com/dart-lang/dartdoc/releases/tag/v0.35.0
Tests
Tested by running
dev/bots/docs.sh
and spot checking the output for any additional warnings (none), and browsing the resulting documentation. Dartdoc is slightly faster with this release than the prior version (30% faster on initialization, roughly equivalent on documentation generation speed).