Skip to content

Commit

Permalink
docs: update with more links
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii committed Mar 9, 2021
1 parent c2d17f9 commit 8127a67
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
4 changes: 2 additions & 2 deletions docs/plotting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion tests/test_uhi.py
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit 8127a67

Please sign in to comment.