Skip to content

Docmentation: update score and related documentation to mention the model column#260

Merged
nikosbosse merged 2 commits intomasterfrom
seabbs/issue232
Jan 13, 2023
Merged

Docmentation: update score and related documentation to mention the model column#260
nikosbosse merged 2 commits intomasterfrom
seabbs/issue232

Conversation

@seabbs
Copy link
Copy Markdown
Contributor

@seabbs seabbs commented Jan 12, 2023

This PR closes #232 by making the model column soft requirement clear. In addition it fleshes out the documentation for score and links the data argument with the other places it is used (i.e check_forecasts()).

Making the data argument be inherited from score does flag that the documentaton was a litle misleading in parts for some functions. I think this should be addressed in another PR vs here.

@seabbs seabbs requested a review from nikosbosse January 12, 2023 17:20
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 12, 2023

Codecov Report

Merging #260 (de2bc0b) into master (a0e4a5f) will not change coverage.
The diff coverage is n/a.

❗ Current head de2bc0b differs from pull request most recent head 4290d87. Consider uploading reports for the commit 4290d87 to get more accurate results

@@           Coverage Diff           @@
##           master     #260   +/-   ##
=======================================
  Coverage   91.36%   91.36%           
=======================================
  Files          21       21           
  Lines        1366     1366           
=======================================
  Hits         1248     1248           
  Misses        118      118           
Impacted Files Coverage Δ
R/avail_forecasts.R 100.00% <ø> (ø)
R/score.R 100.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@seabbs seabbs added the documentation Improvements or additions to documentation label Jan 12, 2023
Copy link
Copy Markdown
Collaborator

@nikosbosse nikosbosse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing, thank you!

@nikosbosse nikosbosse merged commit 43b3394 into master Jan 13, 2023
@seabbs seabbs deleted the seabbs/issue232 branch January 30, 2023 18:01
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Silent model column requirement

2 participants