Skip to content

Not all links get cross-referenced #1343

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

Closed
1 of 2 tasks
Hixie opened this issue Feb 13, 2017 · 5 comments · Fixed by #1891
Closed
1 of 2 tasks

Not all links get cross-referenced #1343

Hixie opened this issue Feb 13, 2017 · 5 comments · Fixed by #1891
Assignees
Labels
customer-flutter Issues originating from important to Flutter P1 A high priority bug; for example, a single project is unusable or has many test failures
Milestone

Comments

@Hixie
Copy link
Contributor

Hixie commented Feb 13, 2017

For example, on this page:
https://docs.flutter.io/flutter/flutter_test/TestGesture-class.html
...WidgetTester.startGesture doesn't get cross-linked to anything.

  • We should cross link anything that's valid.
  • We should hard fail any time there's something we're not able to cross-link.
@Hixie Hixie added customer-flutter Issues originating from important to Flutter P1 A high priority bug; for example, a single project is unusable or has many test failures labels Feb 13, 2017
@jcollins-g jcollins-g added this to the flutter early adopters milestone Apr 21, 2017
@jcollins-g
Copy link
Contributor

This bug turns out to have hidden some major problems with canonicalization because there were no hard failures (and the warnings were less than useful). So canonicalization increased substantially the number of things that were mislinked or not linked at all in complex packages.

@jcollins-g jcollins-g self-assigned this Apr 21, 2017
@jcollins-g
Copy link
Contributor

Adding to early adopter milestone because just getting us back to parity from before the attempts to fix other issues on this milestone requires addressing this.

@jcollins-g
Copy link
Contributor

#1390 is a start addressing this issue. We don't yet hard fail, but a future version of dartdoc will have the option to set this as a hard-fail condition.

@jcollins-g
Copy link
Contributor

We are now much better than we used to be at solving this, and cross-links now work in the vast majority of cases (including the referenced example).

What seems to be left here is the option to hard-fail.

@jcollins-g
Copy link
Contributor

The hard fail option is finally here in #1891, and should be fine-grained enough to roll out in Flutter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter P1 A high priority bug; for example, a single project is unusable or has many test failures
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants