Skip to content

Graceful handling of asset-only packages. #2327

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
isoos opened this issue Sep 2, 2020 · 0 comments · Fixed by #2360
Closed

Graceful handling of asset-only packages. #2327

isoos opened this issue Sep 2, 2020 · 0 comments · Fixed by #2360
Assignees
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) type-enhancement A request for a change that isn't a bug

Comments

@isoos
Copy link
Contributor

isoos commented Sep 2, 2020

When a package has no .dart files in it, dartdoc fails with the following output:

Unhandled exception:
dartdoc could not find any libraries to document
#0      Dartdoc.generateDocs (package:dartdoc/dartdoc.dart:218:9)
<asynchronous suspension>
#1      main (file:///project/pkg/pub_dartdoc/bin/pub_dartdoc.dart:27:33)
<asynchronous suspension>
#2      _startIsolate.<anonymous closure> (dart:isolate-patch/isolate_patch.dart:299:32)
#3      _RawReceivePortImpl._handleMessage (dart:isolate-patch/isolate_patch.dart:168:12)

Instead, dartdoc should emit a warning, and still generate the index.html file based on the README.md.

Example package from pub.dev: cupertino_icons, bulma_min.

@srawlins srawlins added type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) P1 A high priority bug; for example, a single project is unusable or has many test failures labels Sep 2, 2020
@jcollins-g jcollins-g added the type-enhancement A request for a change that isn't a bug label Sep 23, 2020
@jcollins-g jcollins-g self-assigned this Sep 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 A high priority bug; for example, a single project is unusable or has many test failures type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants