search

xgcm / xhistogram

Fast, flexible, label-aware histograms for numpy and xarray
https://xhistogram.readthedocs.io
MIT License
89 stars 19 forks source link

Add future warning for core API change #50

Closed dougiesquire closed 3 years ago

dougiesquire commented 3 years ago

https://github.com/xgcm/xhistogram/pull/45 introduces a change to the outputs of xhistogram.core.histogram. This PR adds a FutureWarning to xhistogram.core.histogram to warn users of the upcoming API change.

codecov[bot] commented 3 years ago

Codecov Report

Merging #50 (f460a27) into master (b9907f3) will increase coverage by 0.12%. The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #50      +/-   ##
==========================================
+ Coverage   94.41%   94.54%   +0.12%     
==========================================
  Files           3        3              
  Lines         215      220       +5     
  Branches       58       58              
==========================================
+ Hits          203      208       +5     
  Misses          8        8              
  Partials        4        4
Impacted Files Coverage Δ
xhistogram/core.py 98.51% <100.00%> (+0.02%) :arrow_up:
xhistogram/xarray.py 91.93% <100.00%> (+0.41%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b9907f3...f460a27. Read the comment docs.

dougiesquire commented 3 years ago

That way users will get less unnecessary warning noise.

Nice idea - done