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

Clarify package workflows (e.g. in examples) before release #530

Closed
nikosbosse opened this issue Dec 14, 2023 · 2 comments · Fixed by #877
Closed

Clarify package workflows (e.g. in examples) before release #530

nikosbosse opened this issue Dec 14, 2023 · 2 comments · Fixed by #877
Labels
implementation-ready This is ready for implementation package improvement

Comments

@nikosbosse
Copy link
Contributor

nikosbosse commented Dec 14, 2023

In #511 @seabbs commented on the fact that workflows in the package are a bit confusing and it often isn't really clear what the preferred route through the package is.

One specific thing we could do is update examples and make them more consistent, e.g. by adding

data |>
  as_forecast() |>
  set_forecast_unit() |>
  function()

Another proposal is mentioned in #507, and currently planned is #400. Updating the documentation to clarify workflows would help as well.
@seabbs did you have more thoughts?

@nikosbosse nikosbosse changed the title Clarify workflows in examples Clarify package workflow (e.g. in examples) Dec 14, 2023
@nikosbosse nikosbosse changed the title Clarify package workflow (e.g. in examples) Clarify package workflows (e.g. in examples) Dec 14, 2023
@nikosbosse nikosbosse added this to the scoringutils-2.0 milestone Jan 2, 2024
@nikosbosse nikosbosse added package improvement implementation-ready This is ready for implementation labels Jan 2, 2024
@seabbs
Copy link
Contributor

seabbs commented Feb 28, 2024

As with #532 maybe this is a do just before release issue once all decisions and updates have been made?

@nikosbosse nikosbosse changed the title Clarify package workflows (e.g. in examples) Clarify package workflows (e.g. in examples) before release Feb 28, 2024
@nikosbosse
Copy link
Contributor Author

nikosbosse commented May 5, 2024

Should we stick to the pipe syntax for consistency, and make it clearer to users?

Originally posted by @Bisaloo in #791 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
implementation-ready This is ready for implementation package improvement
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants