Skip to content

Aliases for entries #1836

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

Open
dnfield opened this issue Nov 14, 2018 · 3 comments
Open

Aliases for entries #1836

dnfield opened this issue Nov 14, 2018 · 3 comments
Labels
customer-flutter Issues originating from important to Flutter P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug

Comments

@dnfield
Copy link

dnfield commented Nov 14, 2018

See flutter/flutter#24351

We redid a bunch of classes that were declared like this:

abstract class ReallyAMixin {
  factory ReallyAMixin._() => null;
  ...
}

To this:

mixin ReallyAMixin {
}

Which now is resulting in a new Dart doc link (...-mixin.html instead of ...-class.html), which is breaking external links. Is there some sensible way we could alias ReallyAMixin-class.html to ReallyAMixin-mixin.html? Obiviously for docs we control we should just update the links, but this might hurt things like old StackOverflow answers or blog posts.

/cc @gspencergoog @sfshaza2

@dnfield
Copy link
Author

dnfield commented Nov 14, 2018

If there's no existing way, it might be nice to have something like:

/// {@alias abstract class ReallyAMixin}

Or perhaps some other top level file that control such things, for cases where types get renamed.

@jcollins-g
Copy link
Contributor

I like the idea of a top level control file for this sort of thing. In the meantime, you could probably patch this particular case of it up in post-processing.

@jcollins-g jcollins-g added P2 A bug or feature request we're likely to work on customer-flutter Issues originating from important to Flutter type-enhancement A request for a change that isn't a bug labels Nov 14, 2018
@guidezpl
Copy link
Contributor

guidezpl commented May 23, 2022

Related, #1346 would make this obsolete for type changes if it were generalized

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 P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

3 participants