From 8127a6729c713f1b3a43ae2c596a599a0a2e4fa1 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 9 Mar 2021 10:18:18 -0500 Subject: [PATCH] docs: update with more links --- README.md | 8 +++++++- docs/plotting.rst | 4 ++-- tests/test_uhi.py | 3 ++- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7ba2fe5..9efcf94 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ [![Scikit-HEP][sk-badge]](https://scikit-hep.org/) -This is a package meant primarily for documenting histogram indexing and the PlottableProtocol and any future cross-library standards. It also contains the code for the PlottableProtocol, to be used in type checking libraries wanting to conform to the protocol. Eventually, it might gain a set of tools for testing conformance to UHI indexing, as well. It is not intended to be a runtime dependency, but only a type checking, testing, and/or docs dependency in support of our other libraries (boost-histogram, hist, mplhep, histoprint). It requires Python 3.6+. +This is a package meant primarily for [documenting][rtd-link] histogram indexing and the PlottableProtocol and any future cross-library standards. It also contains the code for the PlottableProtocol, to be used in type checking libraries wanting to conform to the protocol. Eventually, it might gain a set of tools for testing conformance to UHI indexing, as well. It is not currently intended to be a runtime dependency, but only a type checking, testing, and/or docs dependency in support of other libraries (such as [boost-histogram][], [hist][], [mplhep][], [uproot4][], and eventually [histoprint][]). It requires Python 3.6+. [actions-badge]: https://github.com/Scikit-HEP/uhi/workflows/CI/badge.svg @@ -32,3 +32,9 @@ This is a package meant primarily for documenting histogram indexing and the Plo [rtd-badge]: https://readthedocs.org/projects/uhi/badge/?version=latest [rtd-link]: https://uhi.readthedocs.io/en/latest/?badge=latest [sk-badge]: https://scikit-hep.org/assets/images/Scikit--HEP-Project-blue.svg + +[boost-histogram]: https://github.com/scikit-hep/boost-histogram +[hist]: https://github.com/scikit-hep/hist +[mplhep]: https://github.com/scikit-hep/mplhep +[uproot4]: https://github.com/scikit-hep/uproot4 +[histoprint]: https://github.com/scikit-hep/histoprint diff --git a/docs/plotting.rst b/docs/plotting.rst index 2de7d84..6e5e918 100644 --- a/docs/plotting.rst +++ b/docs/plotting.rst @@ -63,8 +63,8 @@ Then, check your library against the Protocol like this: _: PlottableHistogram = cast(MyHistogram, None) -The full protocol version 1 follows: -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The full protocol version 1.1 follows: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ (Also available as ``uhi.typing.plottable.PlottableProtocol``, for use in tests, etc. diff --git a/tests/test_uhi.py b/tests/test_uhi.py index 08cbf07..8c80d1a 100644 --- a/tests/test_uhi.py +++ b/tests/test_uhi.py @@ -1,6 +1,7 @@ -from uhi import __version__ import sys +from uhi import __version__ + if sys.version_info < (3, 8): import importlib_metadata as metadata else: