-
Notifications
You must be signed in to change notification settings - Fork 705
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
Added info on dependency version constraints #5431
Conversation
/gcbrun |
Visit the preview URL for this PR (updated for commit cd7aafc): |
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.
Thanks for taking this on @atsansone!
I have a few comments and suggestions, including reducing the scope a bit to focus on what we can be more confident in suggesting. Let me know if you have any questions, would like to chat further, or if you'd like me to further propose some text.
Thanks!
src/tools/pub/dependencies.md
Outdated
like `^2.0.0`, or tight, specifying dependency at the lowest version digit like | ||
`^1.2.4`. | ||
|
||
In your `pubspec.yaml` file, follow these recommendations. |
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'm not sure we need to mention this as this whole section is about dependencies in the pubspec.yaml
file and recommendations for those dependencies. I think we can just focus on the best practices.
@parlough : PTAL. |
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.
Thanks for continuing the adjustments @atsansone! Definitely easier to follow now.
I have a few remaining concerns and some suggestions to consider. Feel free to push back on anything that doesn't make sense or let me know if you'd like to chat about any of them.
Thanks again :D
src/tools/pub/dependencies.md
Outdated
An example of how to set versions for dependencies would resemble the | ||
following `pubspec.yaml` example. |
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.
Thanks for adding this introduction!
I think "example" was accidentally added twice though, ending up sounding like this: "An example would resemble the following example".
How about something like: "Tightening the version constraints of your dev dependencies might resemble the following:"
An example of how to set versions for dependencies would resemble the | |
following `pubspec.yaml` example. | |
Tightening the version constraints of your dev dependencies | |
might resemble the following: |
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.
Fixed.
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.
Thanks for those adjustments @atsansone! One more area that needs to be updated, but otherwise looks great.
Co-authored-by: Parker Lougheed <parlough@gmail.com>
Fixes #4811