-
Notifications
You must be signed in to change notification settings - Fork 704
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated version constraint copy #5165
Conversation
@atsansone can you stage this? |
src/tools/pub/dependencies.md
Outdated
[`--enforce-lockfile`]: /tools/pub/cmd/pub-get#--enforce-lockfile | ||
[lockfile]: /tools/pub/glossary#lockfile | ||
[content hashes]: /tools/pub/glossary#content-hashes | ||
[`--enforce-lockfile`]: {{site.url}}/tools/pub/cmd/pub-get#--enforce-lockfile |
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 haven't taken a look at this PR yet, but just scanning quickly, we don't use {{site.url}}
on dart.dev. Just the base relative URLs.
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.
True, and I will remove. I think we should going forward to be consistent between both sites.
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.
That's the goal. I hope to make it no longer necessary on flutter/website soon.
Consider getting someone on the pub team to review this as well once it is staged. |
src/tools/pub/dependencies.md
Outdated
Here's an example of specifying a dependency: | ||
[_source_]: {{site.url}}/tools/pub/glossary#source | ||
|
||
To specify a dependency: |
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.
The old text does make clear that this is an example.
To me it wrong to claim that this how an example
src/tools/pub/dependencies.md
Outdated
How can you communicate to other developers which version of Package B | ||
has been verified with a given version of Package A? |
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.
verified is a strong claim here.
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.
Maybe use 'compatible'?
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.
LGTM with the comments
<em>exact</em> version. Avoid using this when you can because it can cause | ||
version lock for your users and make it hard for them to use your package | ||
along with other packages that also depend on it. | ||
You can specify any combination of version values as their ranges intersect. |
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.
What it is exactly we mean here?
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 have a better explanation in the updated copy.
src/tools/pub/dependencies.md
Outdated
How can you communicate to other developers which version of Package B | ||
has been verified with a given version of Package A? |
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.
Maybe use 'compatible'?
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.
@jonasfj , @szakarias , @parlough : Made updates per your comments.
<em>exact</em> version. Avoid using this when you can because it can cause | ||
version lock for your users and make it hard for them to use your package | ||
along with other packages that also depend on it. | ||
You can specify any combination of version values as their ranges intersect. |
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 have a better explanation in the updated copy.
src/tools/pub/dependencies.md
Outdated
[`--enforce-lockfile`]: /tools/pub/cmd/pub-get#--enforce-lockfile | ||
[lockfile]: /tools/pub/glossary#lockfile | ||
[content hashes]: /tools/pub/glossary#content-hashes | ||
[`--enforce-lockfile`]: {{site.url}}/tools/pub/cmd/pub-get#--enforce-lockfile |
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.
True, and I will remove. I think we should going forward to be consistent between both sites.
Rewrote details on version constraints. Fixes #4160 Staged: https://dart--staging--dart-mrtpv5g3.web.app/tools/pub/dependencies#version-constraints
Rewrote details on version constraints. Fixes dart-lang#4160 Staged: https://dart--staging--dart-mrtpv5g3.web.app/tools/pub/dependencies#version-constraints
Rewrote details on version constraints. Fixes #4160
Staged: https://dart--staging--dart-mrtpv5g3.web.app/tools/pub/dependencies#version-constraints