Skip to content
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

Merged
merged 5 commits into from
Mar 27, 2024

Conversation

atsansone
Copy link
Contributor

Fixes #4811

@atsansone atsansone added the review.copy Awaiting Copy Review label Dec 26, 2023
@parlough parlough self-requested a review December 28, 2023 01:26
@atsansone atsansone requested review from MaryaBelanger and removed request for parlough January 11, 2024 23:14
@atsansone
Copy link
Contributor Author

/gcbrun

@dart-github-bot
Copy link
Collaborator

dart-github-bot commented Jan 11, 2024

Visit the preview URL for this PR (updated for commit cd7aafc):

https://dart-dev--pr5431-fix-4811-l4rp6ph3.web.app

Copy link
Member

@parlough parlough left a 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 Show resolved Hide resolved
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.
Copy link
Member

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.

src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
@parlough parlough added review.await-update Awaiting Updates after Edits and removed review.copy Awaiting Copy Review labels Jan 12, 2024
@atsansone atsansone added review.copy Awaiting Copy Review and removed review.await-update Awaiting Updates after Edits labels Jan 13, 2024
@atsansone atsansone assigned parlough and unassigned atsansone Jan 13, 2024
@atsansone
Copy link
Contributor Author

@parlough : PTAL.

@parlough parlough self-requested a review January 16, 2024 16:29
Copy link
Member

@parlough parlough left a 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 Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
Comment on lines 451 to 452
An example of how to set versions for dependencies would resemble the
following `pubspec.yaml` example.
Copy link
Member

@parlough parlough Jan 25, 2024

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:"

Suggested change
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:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

src/tools/pub/dependencies.md Outdated Show resolved Hide resolved
@parlough parlough added review.await-update Awaiting Updates after Edits and removed review.copy Awaiting Copy Review labels Jan 25, 2024
@parlough parlough assigned atsansone and unassigned parlough Jan 25, 2024
@parlough parlough removed the request for review from MaryaBelanger January 25, 2024 16:55
@atsansone atsansone added review.copy Awaiting Copy Review and removed review.await-update Awaiting Updates after Edits labels Feb 12, 2024
Copy link
Member

@parlough parlough left a 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.

src/content/tools/pub/dependencies.md Outdated Show resolved Hide resolved
@parlough parlough added st.RFM.% Ready to Merge but has suggestions and removed review.copy Awaiting Copy Review labels Mar 25, 2024
@parlough parlough removed their assignment Mar 25, 2024
@atsansone atsansone merged commit e6ace7e into dart-lang:main Mar 27, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
st.RFM.% Ready to Merge but has suggestions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add best practice about setting version constraints to 'Package dependencies' page
4 participants