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

(hex)docs: types in function signatures should be clickable links to their documentation #3461

Open
george-grec opened this issue Jul 31, 2024 · 1 comment · May be fixed by #3471
Open

(hex)docs: types in function signatures should be clickable links to their documentation #3461

george-grec opened this issue Jul 31, 2024 · 1 comment · May be fixed by #3471
Labels
help wanted Contributions encouraged priority:medium

Comments

@george-grec
Copy link

george-grec commented Jul 31, 2024

When looking at the documentation of a function on hexdocs such as this one

screenshot

... I want to click on types (Request, Connection, FileError) and see their documentation. As it is now, I always have to select, copy and paste them into the search bar. Even more critically, sometimes the types are not defined in the same package (as is the case for FileError) and then you have to go to the source code to find out more (it turns out FileError is from simplifile!).

@lpil
Copy link
Member

lpil commented Jul 31, 2024

Thank you

@lpil lpil added help wanted Contributions encouraged priority:medium labels Jul 31, 2024
@joshi-monster joshi-monster linked a pull request Aug 1, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Contributions encouraged priority:medium
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants