docs(layout::Constraint): add doc-comments for all variants #371
Conversation
This file contains 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
hasezoey
requested review from
orhun,
mindoodoo,
sayanarijit,
sophacles,
joshka and
kdheepak
as code owners
Codecov Report
@@ Coverage Diff @@
## main #371 +/- ##
=======================================
Coverage 84.99% 84.99%
=======================================
Files 40 40
Lines 8686 8686
=======================================
Hits 7383 7383
Misses 1303 1303
|
|
See #354 (comment) for some detail on the panic. I was mistaken. |
hasezoey
commented
Aug 5, 2023
joshka
requested changes
Aug 5, 2023
There was a problem hiding this comment.
This looks great. There was some discussion about when to use doctests vs unit tests in #324. I think this is a perfect example of when asserts in doc tests are useful as it helps show much more detail about the edge cases. If these were instead unit tests, they would not be as discoverable.
Change requested is just the comments about the panicing / github comment.
hasezoey
force-pushed
the
docConstraintVariants
branch
from
2f9845e
to
c7e8cb5
Compare
joshka
approved these changes
Aug 5, 2023
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.
This PR adds at least some documentation on what each variant does, with examples (and so doc-tests)
fixes #354