Fix (#59)

* fixed codecov test, and added more documentation on codecov
* small fix in README

Author: fpgmaas

README.md

@@ -74,7 +74,7 @@ git push -u origin main
 
 Finally, install the environment and the pre-commit hooks with
 
- ```
+ ```bash
  make install
  ```
 
@@ -86,6 +86,7 @@ To finalize the set-up for publishing to PyPi or Artifactory, see
 [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
 For activating the automatic documentation with MkDocs, see
 [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
+To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
 
 ## Acknowledgements
 

docs/index.md

@@ -71,15 +71,15 @@ git push -u origin main
 
 Finally, install the environment and the pre-commit hooks with
 
- ```
+ ```bash
  make install
  ```
 
 You are now ready to start development on your project! The CI/CD
 pipeline will be triggered when you open a pull request, merge to main,
 or when you create a new release.
 
-To finalize the set-up for publishing to PyPi or Artifactory, see [here](./features/publishing.md#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](./features/mkdocs.md#enabling-the-documentation-on-github). 
+To finalize the set-up for publishing to PyPi or Artifactory, see [here](./features/publishing.md#set-up-for-pypi). For activating the automatic documentation with MkDocs, see [here](./features/mkdocs.md#enabling-the-documentation-on-github). To enable the code coverage reports, see [here](./features/codecov).
 
 ## Acknowledgements
 

{{cookiecutter.project_name}}/README.md

@@ -26,7 +26,11 @@ git remote add origin [email protected]:{{cookiecutter.author_github_handle}}/{{coo
 git push -u origin main
 ```
 
-Finally, install the environment and the pre-commit hooks with `make install`.
+Finally, install the environment and the pre-commit hooks with 
+
+```bash
+make install
+```
 
 You are now ready to start development on your project! The CI/CD
 pipeline will be triggered when you open a pull request, merge to main,
@@ -36,6 +40,7 @@ To finalize the set-up for publishing to PyPi or Artifactory, see
 [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
 For activating the automatic documentation with MkDocs, see
 [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
+To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
 
 ## Releasing a new version
 

{{cookiecutter.project_name}}/{{cookiecutter.project_slug}}/foo.py

@@ -13,5 +13,5 @@ def foo() -> str:
     return "foo"
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: no cover
     print(foo())