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.

Sign up for GitHub

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

Jump to bottom

[docs] all type aliases should be de-referenced #2020

Closed
adidahiya opened this issue Jan 18, 2018 · 2 comments
Closed

[docs] all type aliases should be de-referenced #2020

adidahiya opened this issue Jan 18, 2018 · 2 comments
Assignees
@giladgray
Labels
Domain: documentation Type: enhancement
Milestone
2.0.0

Comments

@adidahiya
Copy link
Contributor

even with #1982, we still have some references that are opaque and not useful, like TreeEventHandler:

image
@adidahiya adidahiya added this to the 2.0.0 milestone Jan 18, 2018
@giladgray
Copy link
Contributor

giladgray commented Jan 19, 2018 •
edited
Loading

@adidahiya my next docs PR will introduce an API browser that includes type aliases, so you'll be able to click on TreeEventHandler and see what it aliases. would that address this issue? we could take it a step further and put a popover on aliases that shows aliased type?

@adidahiya
Copy link
Contributor Author

Either of those approaches would work. Popover is better UX.

@giladgray giladgray self-assigned this Jan 24, 2018
@giladgray giladgray mentioned this issue Jan 25, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@giladgray giladgray

Labels
Domain: documentation Type: enhancement
Projects
None yet
Milestone
2.0.0
Development

No branches or pull requests
2 participants
@giladgray @adidahiya