From 4164524c32d1836eb77c1d01e291462e80d1d069 Mon Sep 17 00:00:00 2001 From: Fabian Joswig Date: Sat, 14 May 2022 12:12:50 +0100 Subject: [PATCH] docs: examples workflow documented, badge added to README --- CONTRIBUTING.md | 5 +++-- README.md | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d95d672..98ab0c75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,9 +22,10 @@ Please add docstrings to any new function, class or method you implement. The do When implementing a new feature or fixing a bug please add meaningful tests to the files in the `tests` directory which cover the new code. For all pull requests tests are executed for the most recent python releases via ``` -pytest --cov=pyerrors -vv +pytest -vv --cov=pyerrors +pytest -vv --nbmake examples/*.ipynb ``` -requiring `pytest`, `pytest-cov` and `pytest-benchmark`. To get a coverage report in html run +requiring `pytest`, `pytest-cov`, `pytest-benchmark` and `nbmake`. To get a coverage report in html run ``` pytest --cov=pyerrors --cov-report html ``` diff --git a/README.md b/README.md index 54382571..67d59be0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![flake8](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [![pytest](https://github.com/fjosw/pyerrors/actions/workflows/pytest.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/pytest.yml) [![docs](https://github.com/fjosw/pyerrors/actions/workflows/docs.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/docs.yml) [![](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![flake8](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/flake8.yml) [![pytest](https://github.com/fjosw/pyerrors/actions/workflows/pytest.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/pytest.yml) [![examples](https://github.com/fjosw/pyerrors/actions/workflows/examples.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/examples.yml) [![docs](https://github.com/fjosw/pyerrors/actions/workflows/docs.yml/badge.svg)](https://github.com/fjosw/pyerrors/actions/workflows/docs.yml) [![](https://img.shields.io/badge/python-3.7+-blue.svg)](https://www.python.org/downloads/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) # pyerrors `pyerrors` is a python package for error computation and propagation of Markov chain Monte Carlo data.