Skip to content
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

Jump to bottom

Add instructions to view the test coverage reports locally #468

Merged
merged 1 commit into from
Jun 1, 2020
Merged

Add instructions to view the test coverage reports locally #468

merged 1 commit into from
Jun 1, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented May 31, 2020 •
edited
Loading

Description of proposed changes

After tests, run coverage html to generate coverage reports in HTML format.
The coverage reports is located in the htmlcov directory by default.

Fixes #463

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

@seisman
Add instructions to view the test coverage reports locally
87a187d 
After tests, run `coverage html` to generate coverage reports in HTML format.
The coverage reports is located in the `htmlcov` directory by default.
@seisman seisman requested review from leouieda and weiji14 May 31, 2020 23:07
@seisman seisman added the documentation Improvements or additions to documentation label May 31, 2020
@seisman seisman added this to the 0.2.x milestone May 31, 2020
@seisman seisman added this to In progress in Release v0.2.x via automation May 31, 2020
weiji14
weiji14 approved these changes Jun 1, 2020
View reviewed changes
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Wow, I always thought local coverage just means looking at the % covered after running make test. Didn't know you could click and see which lines were missed too (other than on codecov). Looks good!

@seisman
Copy link
Member Author

seisman commented Jun 1, 2020

me too, didn't know it until a few days ago.

@seisman seisman merged commit ee4694e into master Jun 1, 2020
Release v0.2.x automation moved this from In progress to Done Jun 1, 2020
@seisman seisman deleted the coverage branch June 1, 2020 02:54
@weiji14 weiji14 modified the milestones: 0.2.x, 0.1.x Jun 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@weiji14 weiji14 weiji14 approved these changes

@leouieda leouieda Awaiting requested review from leouieda

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Release v0.2.x
  
Done
Milestone
0.1.x
Development

Successfully merging this pull request may close these issues.

Add instructions to view the test coverage reports locally
2 participants
@seisman @weiji14