Skip to content
This repository was archived by the owner on Sep 9, 2020. It is now read-only.

Update the FAQ to use constraint instead of dependencies (reflect #538) #739

Merged
merged 2 commits into from
Jun 12, 2017

Conversation

ibrasho
Copy link
Collaborator

@ibrasho ibrasho commented Jun 10, 2017

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 of dependencies where the reference is to the manifest field.

…ndencies)

[[dependencies]] was changed to [[constraint]] but the FAQ had answers
that used the old field.

Signed-off-by: Ibrahim AshShohail <[email protected]>
@ibrasho ibrasho added the docs label Jun 10, 2017
@ibrasho ibrasho changed the title Update the FAQ to reflect #538. (use constraint instead of dependencies) Update the FAQ to use constraint instead of dependencies (reflect #538) Jun 10, 2017
@ibrasho
Copy link
Collaborator Author

ibrasho commented Jun 10, 2017

This PR complements the changes in #736.

behave differently:

* Dependencies:
* Constraints:
Copy link
Collaborator

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 constraints.
👍

Copy link
Collaborator

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.

Copy link
Collaborator

@carolynvs carolynvs left a 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
Copy link
Collaborator

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.

Copy link
Collaborator Author

@ibrasho ibrasho Jun 11, 2017

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 😄

@sdboyer sdboyer merged commit 32ace93 into golang:master Jun 12, 2017
@sdboyer
Copy link
Member

sdboyer commented Jun 12, 2017

LGTM 😀

@ibrasho ibrasho deleted the update-FAQ branch June 15, 2017 18:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants