Skip to content

Commit

Permalink
Mention time_step in docs where applicable
Browse files Browse the repository at this point in the history
  • Loading branch information
mtsch committed Jan 6, 2025
1 parent 3acd726 commit cb2fc87
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/StatsTools/reweighting.jl
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ Returns a `NamedTuple` with the fields
* `threading = Threads.nthreads() > 1`: if `false` a progress meter is displayed
* `shift_name = :shift` name of column in `df` with shift data
* `norm_name = :norm` name of column in `df` with walkernumber data
* `time_step = determine_constant_time_step(df)` the time step
* `warn = true` whether to log warning messages when blocking fails or denominators are
small
Expand All @@ -242,8 +243,8 @@ function growth_estimator_analysis(
threading=Threads.nthreads() > 1,
shift_name=:shift,
norm_name=:norm,
warn=true,
time_step=nothing,
warn=true,
kwargs...
)
df = DataFrame(sim)
Expand Down Expand Up @@ -389,6 +390,7 @@ Returns a `NamedTuple` with the fields
* `shift_name = :shift` name of column in `df` with shift data
* `hproj_name = :hproj` name of column in `df` with operator overlap data
* `vproj_name = :vproj` name of column in `df` with projector overlap data
* `time_step = determine_constant_time_step(df)` the time step
* `warn = true` whether to log warning messages when blocking fails or denominators are small
## Example
Expand Down

0 comments on commit cb2fc87

Please sign in to comment.