Skip to content

Commit 636de21

Browse files
committed
fix documentation
1 parent a03878f commit 636de21

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

TODO.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33

44

5-
* [ ] Documentation of bootstrap_copyable (and bootstrap) is currently wrong (sqrt of variance) - fix that!
65

76
# Finished TODOs
87

8+
- [x] Documentation of bootstrap_copyable (and bootstrap) is currently wrong (sqrt of variance) - fix that!
99
- [x] `is_initialized()` function for WL
1010
- [x] Documentation for WangLandau acc methods
1111
- [x] Documentation for entropic acc methods

src/bootstrap.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! Bootstrap resampling functions
22
use rand::{seq::*, Rng};
33

4-
/// returns reduced value + estimated error (as sqrt of variance).
4+
/// returns reduced value + variance (estimated error is sqrt of variance)
55
/// Note, that you can use [bootstrap_copyable]
66
/// if your `N1` implements Copy
77
pub fn bootstrap<F, R, N1>(mut rng: R, samples: usize, data: &[N1], reduction: F) -> (f64, f64)

0 commit comments

Comments
 (0)