Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: evaluate.VelDist missing keyword argument description #31

Open
3 tasks
kay-ro opened this issue Jun 3, 2024 · 0 comments
Open
3 tasks

DOC: evaluate.VelDist missing keyword argument description #31

kay-ro opened this issue Jun 3, 2024 · 0 comments
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

Comments

@kay-ro
Copy link

kay-ro commented Jun 3, 2024

Problem description:

The documentation of the VelDist evaluation class is missing the description of several keyword arguments, namely vmin, 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:

  • extend class call with type hints
  • add missing descriptions of keyword arguments in documentation
  • potentially fix the calculation for the upper limits of the distribution for v² and |v| - or document behavior thoroughly
@kay-ro kay-ro added documentation Improvements or additions to documentation module: evaluate labels Jun 3, 2024
@kay-ro kay-ro added this to the release v1.0.2 milestone Jun 3, 2024
@hechtprojects hechtprojects added status: to do Issues that someone needs to work on release: patch Issues that need to be addressed in a patch release labels Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants