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

add option to hide deprecated APIs in web view #3921

Open
Luckey-Elijah opened this issue Oct 30, 2024 · 3 comments
Open

add option to hide deprecated APIs in web view #3921

Luckey-Elijah opened this issue Oct 30, 2024 · 3 comments
Labels
area-web-design Something a web designer interested in helping could do. P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug

Comments

@Luckey-Elijah
Copy link

Example: When browsing pub.dev/documentation/somepackage I would like the ability to "hide" all deprecated APIs as developers would not be needing to read the APIs.

@srawlins
Copy link
Member

Thanks for the suggestion! I would say that, until the API is no longer available, a developer may want to see the deprecated API, so that they can read how to stop using it; what the replacement is; what the old signature is vs what the replacement is; why it is being removed, etc.

@Luckey-Elijah
Copy link
Author

Yes I agree. I think that the ability to view them should be priority. Just for those that know they don't need to see them, it would be nice to hide those unused APIs.

A more specific use case: flutter_riverpod is preparing for a "big version 3 release" so many APIs are marked as deprecated. From a simple document.querySelectorAll('.deprecated').length; query I can see that 69 elements (at the time of this comment) are marked as deprecated. Those entries are valuable to those who need them but can be an "eye sore" or generally unhelpful for those that are not using API deprecated APIs; hence, the idea to toggle hide/showing them.

I currently can use

document.querySelectorAll('.deprecated').forEach(function(el) {
   el.style.display = 'none'; // use null to revert
});

in the browser console to get an idea of how I would want it to look.

Hopefully, this is more helpful for what I had in mind.

@srawlins
Copy link
Member

Ah I see. Yes this would be a cool feature. A little toggle.

@srawlins srawlins added type-enhancement A request for a change that isn't a bug P3 A lower priority bug or feature request area-web-design Something a web designer interested in helping could do. labels Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-web-design Something a web designer interested in helping could do. P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

2 participants