-
Notifications
You must be signed in to change notification settings - Fork 1k
Update the FAQ to use constraint instead of dependencies (reflect #538) #739
Conversation
…ndencies) [[dependencies]] was changed to [[constraint]] but the FAQ had answers that used the old field. Signed-off-by: Ibrahim AshShohail <[email protected]>
This PR complements the changes in #736. |
behave differently: | ||
|
||
* Dependencies: | ||
* Constraints: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought of replacing "Dependencies" with "Constraints" around this section, but resisted thinking we might keep using "Dependencies" for direct dependencies as a reference to constraint
s.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is in the context of explaining the diff between [constraint]
and [override]
, I agree that it makes more sense to use the term Constraints
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for keeping our FAQ up-to-date! ❤️
FAQ.md
Outdated
behave differently: | ||
|
||
* Dependencies: | ||
* Constraints: | ||
1. Can be declared by any project's manifest, yours or a dependency | ||
2. Apply only to direct dependencies of the project declaring the constraint | ||
3. Must not conflict with the `dependencies` declared in any other project's manifest |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! There's one more that needs to be updated from dependencies
to [constraint]
's. Not 100% sure how to refer to the header in the plural form.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was updated in #736 😄
LGTM 😀 |
What does this do / why do we need it?
[[dependencies]] was changed to [[constraint]] but the FAQ still has answers that reference the old field.
Which issue(s) does this PR fix?
Update the FAQ to use
constraints
instead ofdependencies
where the reference is to the manifest field.