From c839733728bb4240112d898f338c1e3c12dcc89c Mon Sep 17 00:00:00 2001 From: Hans Dembinski Date: Mon, 23 Jan 2023 15:05:10 +0100 Subject: [PATCH] Update README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 5710e06..4f789f4 100644 --- a/README.rst +++ b/README.rst @@ -41,12 +41,12 @@ pyhepmc is part of the Scikit-HEP project, which aims to provide all tools neede **pyhepmc is thoroughly unit tested** -We have 100% coverage for the Python API. +We have close to 100% coverage for the Python API. Documentation ------------- -pyhepmc largely mirrors the C++ interface of the `HepMC3 library, which is documented here `_. Parts of the documentation have been copied from HepMC3. Documentation is available as Python docstrings, so you can use Python's ``help()`` browser to learn about the API. Alternatively, you can consult `the online reference generated from these docstrings `_ which includes some examples. +`Documentation is available here `_, and includes some examples (Jupyter notebooks). Furthermore, you can use Python's ``help()`` browser to learn about the API. The documentation is generated from Python docstrings, which are translated from the `HepMC3 library, which is documented here `_. License -------