blueprint: add extra comments to Validate{,LayoutConstraints}
#1064
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
2 tasks
This commit ensures that the roles of `Validate{,LayoutConstraints}`
are clearer from the code comments.
Follwup, c.f.
osbuild#1041 (comment)
mvo5
force-pushed
the
validate-layout-constraints-comment
branch
from
330bb3c
to
e5dd018
Compare
achilleas-k
approved these changes
Nov 25, 2024
|
Skipping the tests and the queue. PR is only docstring changes. |
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 commit ensures that the roles of
Validate{,LayoutConstraints}are clearer from the code comments.Follwup, c.f.
#1041 (comment)
[fwiw, writing it down like this still makes me feel like we currently optimize for the uncommon case here and users can easily forget to call the right API, but adding these comments is useful hopefully in any case]