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

[Documentation] add qc check documentation to TheiaCoV #701

Merged
merged 1 commit into from
Dec 31, 2024

Conversation

sage-wright
Copy link
Member

@sage-wright sage-wright commented Dec 26, 2024

This PR closes #572

🗑️ This dev branch should be deleted after merging to main.

🧠 Summary

This PR adds the qc_check part to the TheiaCoV docs. Looks like this had been done but after I transferred everything over, so I copied it into our stuff.

⚡ Impacted Workflows/Tasks

This PR may lead to different results in pre-existing outputs: Yes/No

This PR uses an element that could cause duplicate runs to have different results: Yes/No

🛠️ Changes

⚙️ Algorithm

➡️ Inputs

⬅️ Outputs

🧪 Testing

Suggested Scenarios for Reviewer to Test

🔬 Final Developer Checklist

  • Documentation and/or workflow diagrams have been updated if applicable
    • You have updated the latest version for any affected worklows in the respective workflow documentation page and for every entry in the three workflows_overview tables.

🎯 Reviewer Checklist

  • All changed results have been confirmed
  • You have tested the PR appropriately (see the testing guide for more information)
  • All code adheres to the style guide
  • MD5 sums have been updated
  • The PR author has addressed all comments
  • The documentation has been updated

@sage-wright sage-wright marked this pull request as ready for review December 26, 2024 15:09
@sage-wright sage-wright requested a review from a team as a code owner December 26, 2024 15:09
Copy link
Contributor

@Michal-Babins Michal-Babins left a comment

Choose a reason for hiding this comment

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

Adds qc check documentation and template for qc check tsv. Aptly describes qc check task. Only documentation and reference update.

@Michal-Babins Michal-Babins merged commit 36c2748 into main Dec 31, 2024
3 checks passed
@sage-wright sage-wright deleted the smw-qc-check-dev branch January 2, 2025 13:59
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.

[TheiaCoV docs] Missing section on optional qc_check task
2 participants