Skip to content

Conversation

@ubmarco
Copy link
Member

@ubmarco ubmarco commented Oct 16, 2025

  • More structure / headlines
  • Document network recursion limit
  • More explanation how to learn from tests
  • Section that explains the basic schemas structure
  • Primary field typing and relation to schemas.json

Fixes #1542 and #1539.

@codecov
Copy link

codecov bot commented Oct 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.95%. Comparing base (4e10030) to head (c1051a7).
⚠️ Report is 184 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1554      +/-   ##
==========================================
+ Coverage   86.87%   87.95%   +1.07%     
==========================================
  Files          56       70      +14     
  Lines        6532     9606    +3074     
==========================================
+ Hits         5675     8449    +2774     
- Misses        857     1157     +300     
Flag Coverage Δ
pytests 87.95% <ø> (+1.07%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ubmarco ubmarco requested a review from chrisjsewell October 16, 2025 09:55
@ubmarco
Copy link
Member Author

ubmarco commented Oct 16, 2025

@MrChocolateMoose I'd appreciate your feedback on the PR.

Copy link
Member

@chrisjsewell chrisjsewell left a comment

Choose a reason for hiding this comment

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

From a quick scan through, looks all good

@MrChocolateMoose
Copy link

I started reviewing this AM, but should be finished by the end of my day.

@ubmarco
Copy link
Member Author

ubmarco commented Oct 16, 2025

Thanks. Will wait with the merge until tomorrow.

@MrChocolateMoose
Copy link

I looked at the rendered docs and it looks good to me as well. It addresses my checklist of points I wrote.

I had a few side points that depending on the answer could warrant updates to the schema docs (e.g. some confusion on why I would set an enum value on the need field and as a validation schema, no mention of global regex options being disallowed). #1543 and #1536

No need to hold the PR up though. I approve.

@ubmarco ubmarco merged commit 0030e6c into master Oct 17, 2025
31 of 33 checks passed
@ubmarco ubmarco deleted the mh-schema-docs branch October 17, 2025 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Schema Documentation Feedback

3 participants