Skip to content

[WIP] docs: constraints - #6278

Draft
alexarice wants to merge 1 commit into
mainfrom
alexarice/constraint-docs
Draft

[WIP] docs: constraints#6278
alexarice wants to merge 1 commit into
mainfrom
alexarice/constraint-docs

Conversation

@alexarice

Copy link
Copy Markdown
Collaborator

For some reason, something possessed me last friday to start writing documentation for constraints. This is how far I got. I would really like to finish and iterate these because the system seems like a common point of confusion, so I'm making a tracking PR to hold myself accountable.

@alexarice alexarice self-assigned this Jul 20, 2026
@alexarice alexarice added the documentation Documentation label Jul 20, 2026
@codecov

codecov Bot commented Jul 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.94%. Comparing base (a50e4ad) to head (8cd9027).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6278      +/-   ##
==========================================
- Coverage   86.94%   86.94%   -0.01%     
==========================================
  Files         431      431              
  Lines       64899    64898       -1     
  Branches     7420     7420              
==========================================
- Hits        56426    56425       -1     
  Misses       6901     6901              
  Partials     1572     1572              

☔ View full report in Codecov by Harness.
📢 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.

@superlopuh superlopuh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is fantastic, but won't actually be displayed in the website as it is. Let's move it to either docs or the doc string for __init__.py in the folder?

@alexarice

Copy link
Copy Markdown
Collaborator Author

I feel it should be in docs rather than a doc string.

@superlopuh

Copy link
Copy Markdown
Member

Either works for me, happy for it to be in docs. They're in a bit of a messy state right now so I think best thing to do would be to make a self-contained page and then we can put it in the right place later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants