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

Dartdoc 8.0.11 complains about "[this]" on extension types #3818

Closed
nex3 opened this issue Jul 9, 2024 · 3 comments
Closed

Dartdoc 8.0.11 complains about "[this]" on extension types #3818

nex3 opened this issue Jul 9, 2024 · 3 comments

Comments

@nex3
Copy link
Member

nex3 commented Jul 9, 2024

See this GitHub actions run, which is full of errors like:

error: unresolved doc reference [this]
    from sass.SassApiValue.assertSelector: (file:///home/runner/work/dart-sass/dart-sass/lib/src/value.dart:443:16)
  error: unresolved doc reference [this]
    from sass.SassApiValue.assertSimpleSelector: (file:///home/runner/work/dart-sass/dart-sass/lib/src/value.dart:467:1[8](https://github.com/sass/dart-sass/actions/runs/9849486609/job/27193224758?pr=2251#step:4:9))
  error: unresolved doc reference [this]
    from sass.SassApiValue.assertCompoundSelector: (file:///home/runner/work/dart-sass/dart-sass/lib/src/value.dart:4[9](https://github.com/sass/dart-sass/actions/runs/9849486609/job/27193224758?pr=2251#step:4:10)2:20)
  error: unresolved doc reference [this]
    from sass.SassApiValue.assertComplexSelector: (file:///home/runner/work/dart-sass/dart-sass/lib/src/value.dart:517:19)

for code that worked with previous versions of Dartdoc. Note that the current documentation correctly renders [this] as a link to the extension type.

@ntkme
Copy link

ntkme commented Jul 9, 2024

The change was mentioned here: https://github.com/dart-lang/dartdoc/blob/main/CHANGELOG.md#8010

Remove support for [this] as a comment reference. Referring to the
containing element can be written as this [Foo], and referring to 'this'
can just be written as `this`. (#3765)

However, it definitely feels wrong to introduce a breaking change in a patch release.

@srawlins
Copy link
Member

srawlins commented Jul 9, 2024

Yes, sorry. It is intentional. Apologies that it wasn't made in a major version bump. A few more breaking changes should be coming (I guess mainly removing deprecated support), which should be bundled into a 9.0.0 release.

@srawlins
Copy link
Member

Sorry again, but I'll close this as it is intentional.

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

No branches or pull requests

3 participants