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

Multiple Links broken (404) #2218

Closed
crcdng opened this issue May 3, 2024 · 3 comments · Fixed by #2219
Closed

Multiple Links broken (404) #2218

crcdng opened this issue May 3, 2024 · 3 comments · Fixed by #2219

Comments

@crcdng
Copy link

crcdng commented May 3, 2024

URL: https://pub.dev/packages/test

In section https://pub.dev/packages/test#writing-tests

"Tests are specified using the top-level test() function."

"Tests can be grouped together using the group() function."

"You can use the setUp() and tearDown() functions to share code between tests"

These links are broken (404).

@isoos
Copy link

isoos commented May 3, 2024

@crcdng: thanks for reporting it.
/cc @natebosch @jakemac53 - not sure if package:test changed anything recent, but apparently the dartdoc output has changed.

@jakemac53
Copy link
Contributor

I think some APIs moved their actual implementations around, it is re-exported from the original libraries so it wasn't breaking but it did change the dartdoc links.

@natebosch
Copy link
Member

We should try to use links to the same library that users will import from instead of linking to the defining library (or even defining package).

@natebosch natebosch transferred this issue from dart-lang/pub-dev May 6, 2024
natebosch added a commit that referenced this issue May 6, 2024
Closes #2218

These links were to the defining library, which can change without a
user visible breaking change or major version bump. Link instead to the
`package:test/test.dart` library docs for all APIs. The export makes the
dartdoc links work, and these are more stable since they are user facing
and will only change in a major version release.
natebosch added a commit that referenced this issue May 7, 2024
Closes #2218

These links were to the defining library, which can change without a
user visible breaking change or major version bump. Link instead to the
`package:test/test.dart` library docs for all APIs. The export makes the
dartdoc links work, and these are more stable since they are user facing
and will only change in a major version release.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants