Skip to content

Commit 97c7af3

Browse files
committed
docs: fill out changelog a bit
1 parent 2f33e9a commit 97c7af3

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ histogramming, while still providing the power of a full histogram object. See
2222
[what's new](./docs/CHANGELOG.md).
2323

2424
For end users interested in analysis, see [Hist][], a first-party
25-
analyst-friendly histogram library that extends boost-histogram with many new
26-
shortcuts, plotting, and more.
25+
analyst-friendly histogram library that extends boost-histogram with named
26+
axes, many new shortcuts including UHI+, plotting shortcuts, and more.
2727

2828
[uhi]: https://uhi.readthedocs.io
2929
## Usage
@@ -58,7 +58,7 @@ h2 = hist[::sum, ::bh.rebin(2)]
5858

5959
</details>
6060

61-
We support the [uhi][] [PlottableHistogram][] protocol, so boost-histogram/hist
61+
We support the [uhi][] [PlottableHistogram][] protocol, so boost-histogram/[Hist][]
6262
histograms can be plotted via any compatible library, such as [mplhep][].
6363

6464
[uhi]: https://github.com/scikit-hep/uhi
@@ -174,7 +174,7 @@ python3 -m pip install boost-histogram
174174

175175
All the normal best-practices for Python apply; Pip should not be very old (Pip
176176
9 is very old), you should be in a virtual environment, etc. Python 3.6+ is
177-
required; for older versions of Python, version `0.13` will be installed
177+
required; for older versions of Python (3.5 and 2.7), `0.13` will be installed
178178
instead, which is API equivalent to 1.0, but will not be gaining new features.
179179

180180
#### Binaries available:

docs/CHANGELOG.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,36 @@
33
## Version 1.0
44

55
Dropped support for Python 2 and 3.5; removed large numbers of workarounds.
6-
Subclassing histogram components now uses Python 3 class keyword syntax to set
7-
families. Fully statically typed.
6+
Fully statically typed. API compatible with the final `0.x` release for most
7+
uses, except for subclassing; subclassing histogram components now uses Python
8+
3 class keyword syntax to set families.
89

910
#### User changes
1011

1112
* Dropped Python 2.7 and 3.5 support [#512][]
1213
* Removed deprecated `.options` from axes. Use `.traits` instead. [#503][]
14+
* Full static typing available, UHI 0.1.2+ supported. [#516][], [#517][], [519][], [#520][], [#521][], [#523][]
15+
16+
#### Subclassing Histogram changes
17+
1318
* Use keyword class family setting when subclassing histogram components
1419
instead of custom decorator. [#513][]
15-
* Full static typing available. [#520][]
20+
* Structure of internal repr creation changed and made slightly more public. [#518][]
1621

1722
#### Bug fixes
1823
* Consistently show `metadata=` in repr if present; refactored internal repr handling [#518][]
24+
* Minor typing related fixes for rare bugs (especially in `numpy.py`, [#521][])
1925

2026
[#503]: https://github.com/scikit-hep/boost-histogram/pull/503
2127
[#512]: https://github.com/scikit-hep/boost-histogram/pull/512
2228
[#513]: https://github.com/scikit-hep/boost-histogram/pull/513
29+
[#516]: https://github.com/scikit-hep/boost-histogram/pull/516
30+
[#517]: https://github.com/scikit-hep/boost-histogram/pull/517
2331
[#518]: https://github.com/scikit-hep/boost-histogram/pull/518
24-
[#518]: https://github.com/scikit-hep/boost-histogram/pull/520
32+
[#519]: https://github.com/scikit-hep/boost-histogram/pull/519
33+
[#520]: https://github.com/scikit-hep/boost-histogram/pull/520
34+
[#521]: https://github.com/scikit-hep/boost-histogram/pull/521
35+
[#523]: https://github.com/scikit-hep/boost-histogram/pull/523
2536

2637

2738
## Version 0.13

0 commit comments

Comments
 (0)