Skip to content

Commit

Permalink
move note in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
cyrraz committed Mar 27, 2024
1 parent d84cba8 commit 87c2d12
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/basics/1d_hist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,11 +267,6 @@ The function :func:`make_hist() <plothist.histogramming.make_hist>` returns a a

The examples below show how to create a histogram with a category axis in ``boost_histogram`` and plot it with ``plothist``.

.. note::
When we create the histograms in the examples below, we use the argument ``storage=bh.storage.Weight()``.
This is because the functions in ``plothist`` assume histograms with a storage that supports weighted data, where the variance of each bin is tracked (more details `here < https://boost-histogram.readthedocs.io/en/latest/user-guide/storage.html#weight>`_ and `there <https://boost-histogram.readthedocs.io/en/latest/api/boost_histogram.html#boost_histogram._internal.hist.Histogram.variances>`_).
When creating histograms with regular or variable axes with the function :func:`make_hist() <plothist.histogramming.make_hist>`, as in most of the above examples, the storage is automatically set to ``bh.storage.Weight()``, so the user does not have to worry about it.


Integer category
----------------
Expand All @@ -284,6 +279,12 @@ Integer category
:alt: Integer category plot
:width: 500

.. note::
When we create the histograms in this example, we use the argument ``storage=bh.storage.Weight()``.
This is because the functions in ``plothist`` assume histograms with a storage that supports weighted data, where the variance of each bin is tracked (more details `here < https://boost-histogram.readthedocs.io/en/latest/user-guide/storage.html#weight>`_ and `there <https://boost-histogram.readthedocs.io/en/latest/api/boost_histogram.html#boost_histogram._internal.hist.Histogram.variances>`_).
When creating histograms with regular or variable axes with the function :func:`make_hist() <plothist.histogramming.make_hist>`, as in most of the previous examples, the storage is automatically set to ``bh.storage.Weight()``, so the user does not have to worry about it.


String category
---------------

Expand Down

0 comments on commit 87c2d12

Please sign in to comment.