Simplify documentation of "constraints" overview #6257
Merged
Conversation
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
The current documentation sounds somewhat like a sales pitch, rather than documentation. It's a bit wordy, kind of confusing, and seems to "constrain" their purpose to a small set of usage. Constraints can be used for a large number of needs that are not necessarily "basic" ones.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
The current documentation overview for Constraints reads somewhat like a sales pitch, rather than documentation. It's a bit wordy, and kind of grammatically incorrect/confusing. It might be more beneficial to mention "enforcement of workspace package rules" as the main point, rather than towards the end of the description. Additionally, constraints can be used for a large number of needs that are not necessarily "basic" ones.
I'd be fine with expanding the example list, but being sure to specify that these are just examples of how constraints are commonly used. They're not the limit of the capability.
What's the problem this PR addresses?
Unclear documentation.
How did you fix it?
Made it a bit more clear and simple.
Checklist