Skip to content

Inherited members that inherit their documentation should not appear in search dropdown #3411

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
Hixie opened this issue May 8, 2023 · 2 comments
Labels
area-search Issues with the search box 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

@Hixie
Copy link
Contributor

Hixie commented May 8, 2023

If I search for "computeDryLayout" in Flutter's API docs:

https://master-api.flutter.dev/flutter/search.html?q=computeDryLayout

There's dozens of results, but basically all of them are just redundantly repeating the same content as the first one, because they're just subclasses overriding the method to implement it, and thus inheriting the documentation. If we want to argue that having the list of implementations of this method available is useful, then we should put that list in the documentation for the one they're all inheriting from:

https://master-api.flutter.dev/flutter/rendering/RenderBox/computeDryLayout.html

@srawlins srawlins added type-enhancement A request for a change that isn't a bug area-search Issues with the search box labels May 9, 2023
@jcollins-g jcollins-g added the P2 A bug or feature request we're likely to work on label May 9, 2023
@jcollins-g
Copy link
Contributor

jcollins-g commented May 9, 2023

I like the idea of having overrides displayed on element pages. Alternatively, the search results page could indicate element overrides and the search box could say something like "with 12 overrides..." so you could see the list from there.

@Hixie
Copy link
Contributor Author

Hixie commented May 23, 2023

Recent research from the University of Michigan on Flutter API docs is consistent with this issue; specifically, they called out the redundancy in repeating descriptions in the search results.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-search Issues with the search box 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