DOC: evaluate.VelDist missing keyword argument description #31
Labels
documentation
Improvements or additions to documentation
module: evaluate
release: patch
Issues that need to be addressed in a patch release
status: to do
Issues that someone needs to work on
Milestone
Problem description:
The documentation of the
VelDist
evaluation class is missing the description of several keyword arguments, namelyvmin
,vmax
,v2max
. The description how the limits of the distribution for v² and |v| are being calculated is missing.Moreover, the calculation of the upper limit of the distribution for v² and |v|is unclear.
Suggested content improvement:
The text was updated successfully, but these errors were encountered: