Skip to content

Fix small errors in input file docs#841

Merged
tsmbland merged 3 commits intomainfrom
small_docs_fixes
Sep 24, 2025
Merged

Fix small errors in input file docs#841
tsmbland merged 3 commits intomainfrom
small_docs_fixes

Conversation

@tsmbland
Copy link
Collaborator

@tsmbland tsmbland commented Sep 23, 2025

Description

Fixes some small errors/omissions in the docs (some flagged in #820) that didn't warrant their own individual issues

Any ideas how we can automatically flag errors like this/keep this in sync with the code?

@codecov
Copy link

codecov bot commented Sep 23, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.57%. Comparing base (d4fa544) to head (2f51674).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #841   +/-   ##
=======================================
  Coverage   86.57%   86.57%           
=======================================
  Files          47       47           
  Lines        5074     5074           
  Branches     5074     5074           
=======================================
  Hits         4393     4393           
  Misses        474      474           
  Partials      207      207           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tsmbland tsmbland changed the title Fix incorrect field notes Fix small errors in input file docs Sep 23, 2025
@tsmbland tsmbland marked this pull request as ready for review September 23, 2025 12:45
Copy link
Collaborator

@alexdewar alexdewar left a comment

Choose a reason for hiding this comment

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

LGTM!

I was thinking we could automatically validate the schemas with a script (#623). I have made a start, but other things got in the way. I suppose we're not doing lots atm, so maybe I could have another look at it...

Copy link
Collaborator

@dalonsoa dalonsoa left a comment

Choose a reason for hiding this comment

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

I think the schemas should be validated at some point to ensure they align with the input data. As of now, the schemas and the code are rather disconnected.

@tsmbland tsmbland merged commit ce437f6 into main Sep 24, 2025
7 checks passed
@tsmbland tsmbland deleted the small_docs_fixes branch September 24, 2025 08:02
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.

3 participants