[WIP] docs: constraints - #6278
Draft
alexarice wants to merge 1 commit into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
superlopuh
reviewed
Jul 21, 2026
superlopuh
left a comment
Member
There was a problem hiding this comment.
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?
Collaborator
Author
|
I feel it should be in docs rather than a doc string. |
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.