Coveralls and codecov green, expand on what coverage reporting *is*. (#…

…288) - Solves #254 --------- Co-authored-by: David Stansby <[email protected]>
UCL-ARC · Feb 6, 2024 · fe5d2eb · fe5d2eb
1 parent c996d51
commit fe5d2eb
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/docs/pages/ci.md b/docs/pages/ci.md
@@ -19,7 +19,14 @@ We have many projects using github CI, it's both convenient and works well. It's
 
 # Coverage monitoring
 
-| Name                                     | Short description                               | 🚦  |
-| ---------------------------------------- | ----------------------------------------------- | :-: |
-| [Codecov](https://docs.codecov.com/docs) | Hosted service to report code coverage metrics. | 🟢  |
-| [Coveralls](https://docs.coveralls.io/)  | Hosted service to report code coverage metrics. | 🟠  |
+You can check coverage simply in the terminal with the
+[pytest-cov](https://pypi.org/project/pytest-cov/) plugin. However you might
+consider a third-party code coverage analytics and reporting service. There are
+two that we've used and they're both rather similar. They render the code with
+highlighting to show which lines are not executed but the tests, and can track
+test coverage over time.
+
+| Name                                     | Short description                                                                                                                                                                                                                                                                      | 🚦  |
+| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-: |
+| [Codecov](https://docs.codecov.com/docs) | Hosted service to report code coverage metrics. Occasionally slow to update after a report is updated, can be configured to add extra CI checks. This service is probably more widely used and is [free for both open-source and private projects](https://about.codecov.io/pricing/). | 🟢  |
+| [Coveralls](https://docs.coveralls.io/)  | Hosted service to report code coverage metrics. Very similar to codecov and we don't strongly recommend one over the other. This service is only [free for open-source projects](https://coveralls.io/pricing).                                                                        | 🟢  |