Skip to content

Add a blurb to the README about requiring analysis #2753

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.

Sign up for GitHub

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 2 commits into from
Aug 23, 2021
Merged

Add a blurb to the README about requiring analysis #2753

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3b1f47
Add a blurb to the README about requiring analysis
jcollins-g Aug 20, 2021
32a245b
Merge branch 'master' into readme-no-unanalyzeable-code
jcollins-g Aug 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ Run `pub global activate dartdoc` to install the latest version of dartdoc compa

## Generating docs

Run `dartdoc` from the root directory of a package. Here is an example of dartdoc documenting itself:
Run `dartdoc` from the root directory of a package. Your package must analyze without errors
with `dart analyze` or `flutter analyze` as appropriate. Here is an example of dartdoc documenting
itself:

```
$ dartdoc
Expand Down