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

Better handle interaction between timestep and max_delay #428

Open
adrian-lison opened this issue Jan 6, 2024 · 2 comments
Open

Better handle interaction between timestep and max_delay #428

adrian-lison opened this issue Jan 6, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@adrian-lison
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
Throughout the package, the documentation and warnings related to max_delay were written only with a daily resolution in mind. Now that we have the timestep feature, there are some inconsistencies that might confuse users. In particular, it is not 100% clear right now that when the timestep is e.g. weekly, then the max_delay is also in weeks. Part of the problem is that in warning messages about max_delay being too short etc., we report the delay in days, not in timesteps (for consistency).

Describe the solution you'd like
It should be very clear from the documentation that the max_delay is in the units of the timestep. Moreover, in warnings about max_delay etc. it might be necessary to mention this fact too.

Alternatives you have considered

  • Enforcing max_delay to always be in days - but that would not be user-friendly, because we would also have to enforce that it is a multiple of the timestep.
  • Reporting max_delay in warnings etc. always in the number of timesteps. This however requires some more work, as the internal checks currently revert everything to the daily level. Also, do we just say "the maximum observed delay is 3 timesteps"? Or do we want to write "the maximum observed delay is 3 weeks"? And what do we do if e.g. timestep=14 then?

Additional context
Code-wise, things should already be consistent, see changes in #224.

@adrian-lison adrian-lison added the documentation Improvements or additions to documentation label Jan 6, 2024
@seabbs
Copy link
Collaborator

seabbs commented Apr 9, 2024

I think #224 covers some of this but agree we should improve this. I also agree the suggestion solution (documentation is the way to go).

@seabbs seabbs added help wanted Extra attention is needed good first issue Good for newcomers labels Apr 9, 2024
@seabbs
Copy link
Collaborator

seabbs commented Aug 23, 2024

This might relate to #427 and I agree makes it confusing

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

2 participants