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

add which checks are in place in readme #220

Merged
merged 5 commits into from
Feb 18, 2025
Merged

add which checks are in place in readme #220

merged 5 commits into from
Feb 18, 2025

Conversation

peterdudfield
Copy link
Contributor

@peterdudfield peterdudfield commented Feb 18, 2025

Pull Request

Description

Added a description of what checks are in place

#213

How Has This Been Tested?

Ci tests, but just in readme

  • Yes

Checklist:

  • My code follows OCF's coding style guidelines
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked my code and corrected any misspellings

@peterdudfield peterdudfield marked this pull request as ready for review February 18, 2025 10:34
@peterdudfield peterdudfield requested a review from Sukh-P February 18, 2025 10:35
## Validation Checks

We run a number of different validation checks on the data and the forecasts that are made.
These are in place to ensure quality forecasts are made and saved to the database.
Copy link
Member

Choose a reason for hiding this comment

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

Shall we specify that the forecast doesn't run if these aren't passed in some cases? Can make it clear below then in which cases this isn't the case (data filled in i.e.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, thats a good idea

@peterdudfield peterdudfield merged commit ea86720 into main Feb 18, 2025
@peterdudfield peterdudfield deleted the docs/checks branch February 18, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants