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

Add details on pubspec_overrides.yaml to 'Package dependencies' page #5019

Closed
Luckey-Elijah opened this issue Jun 28, 2023 · 1 comment · Fixed by #6462
Closed

Add details on pubspec_overrides.yaml to 'Package dependencies' page #5019

Luckey-Elijah opened this issue Jun 28, 2023 · 1 comment · Fixed by #6462
Assignees
Labels
co.request Community ask for documentation dev.packages Relates to package publishing e1-hours Can complete in < 8 hours of normal, not dedicated, work from.page-issue Reported in a reader-filed concern p2-medium Necessary but not urgent concern. Resolve when possible.

Comments

@Luckey-Elijah
Copy link

Page URL

https://dart.dev/tools/pub/dependencies.html

Page source

https://github.com/dart-lang/site-www/tree/main/src/tools/pub/dependencies.md

Describe the problem

The pub dependencies page should provide information on the pubspec_overrides.yaml file - adding a few lines to the dependency overrides section.

Currently, there is very little information on the pubspec_overrides.yaml file. The closest thing to documentation I could find was in the CHANGELOG for Dart 2.16 and some scattered discussion across various issues open on varying repositories.

Expected fix

No response

Additional context

No response

@Luckey-Elijah Luckey-Elijah changed the title [PAGE ISSUE]: 'Package dependencies' [PAGE ISSUE]: 'Package dependencies' add details on pubspec_overrides.yaml Jun 28, 2023
@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. e1-hours Can complete in < 8 hours of normal, not dedicated, work co.request Community ask for documentation dev.packages Relates to package publishing labels Jun 28, 2023
@atsansone atsansone added the from.page-issue Reported in a reader-filed concern label Jun 28, 2023
@atsansone atsansone changed the title [PAGE ISSUE]: 'Package dependencies' add details on pubspec_overrides.yaml Add details on pubspec_overrides.yamlto 'Package dependencies' page Jun 28, 2023
@atsansone atsansone changed the title Add details on pubspec_overrides.yamlto 'Package dependencies' page Add details on pubspec_overrides.yaml to 'Package dependencies' page Jun 28, 2023
@jonasfj
Copy link
Member

jonasfj commented Feb 25, 2025

@sigurdm this seems pretty easy to do.

We should probably cover it reference documentation, which means:

The package-layout should mention that the file exists, and where you can read more about it.
Same thing about pubspec.yaml reference.

Probably the best place to put the actual documentation is in a section at the end of:
https://dart.dev/tools/pub/dependencies

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
co.request Community ask for documentation dev.packages Relates to package publishing e1-hours Can complete in < 8 hours of normal, not dedicated, work from.page-issue Reported in a reader-filed concern p2-medium Necessary but not urgent concern. Resolve when possible.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants