Skip to content

Commit 1e660dc

Browse files
committed
[hist] Remove mentions of SetBinContent
We decided to not add this method to the public interface because it has unclear semantics for a number of cases, in particular related to global histogram statistics. While it might be fine to allow it in RHistEngine, it would also be confusing to then not have it in RHist.
1 parent 48f5e0d commit 1e660dc

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

hist/histv7/doc/CodeArchitecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Objects of this type are passed by value.
6868

6969
A single bin index, which is just an integer for normal bins.
7070
`Underflow()` and `Overflow()` are special values and not ordered with respect to others.
71-
Objects of this type are passed by value; most notably to `GetBinContent` and `SetBinContent`.
71+
Objects of this type are passed by value; most notably to `GetBinContent`.
7272

7373
### `RBinIndexRange`
7474

hist/histv7/doc/DesignImplementation.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,9 @@ This will copy the arguments, which is fine in this case because `RBinIndex` is
5555
### Special Arguments
5656

5757
Special arguments are passed last.
58-
Examples include
58+
For example
5959
```cpp
6060
template <typename... A> void Fill(const std::tuple<A...> &args, RWeight w);
61-
template <std::size_t N> void SetBinContent(const std::array<RBinIndex, N> &indices, const BinContentType &content);
6261
```
6362
The same works for the variadic function templates that will check the type of the last argument.
6463

0 commit comments

Comments
 (0)