Skip to content

Add documentation on generating coverage reports with pytest and nose#19

Merged
dblandin merged 1 commit intomasterfrom
devon/add-documentation-with-coverage-report-instructions
Apr 21, 2016
Merged

Add documentation on generating coverage reports with pytest and nose#19
dblandin merged 1 commit intomasterfrom
devon/add-documentation-with-coverage-report-instructions

Conversation

@dblandin
Copy link
Contributor

@codeclimate/review 🔎

README.md Outdated
```

By default, coverage.py will create the test coverage report at `./.coverage`.
Simply run the `codeclimate-test-reporter` to send your test report to

Choose a reason for hiding this comment

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

Since this is referring to running a binary, the definite article seems unnecessary?

Choose a reason for hiding this comment

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

I would actually rethink this whole sentence: this is several sections before the important information about configuration (with the repo token, etc.), so "simply running codeclimate-test-reporter" is unlikely to actually work.

We could probably drop this sentence completely, I think: the other headings point the user in the right direction. If anything, perhaps changes should be made to other sections: maybe a section like "Uploading your coverage report" would be more instructive than "CI Integration".

@dblandin dblandin force-pushed the devon/add-documentation-with-coverage-report-instructions branch 2 times, most recently from 6a26b04 to 2942f9f Compare April 21, 2016 23:02
@dblandin dblandin force-pushed the devon/add-documentation-with-coverage-report-instructions branch from 2942f9f to 5cc7ec0 Compare April 21, 2016 23:04
@dblandin dblandin merged commit f32c2c5 into master Apr 21, 2016
@dblandin dblandin deleted the devon/add-documentation-with-coverage-report-instructions branch April 21, 2016 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants