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 links to type aliases #353

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jfmengels
Copy link

Hi 👋

This adds links to type aliases.

Background

I noticed a while back that some types get links (in the type of a function for instance), while some of them don't. I wondered why, and it looks it's as simple as custom types get links, while type aliases don't.

You can see an example here: https://package.elm-lang.org/packages/mdgriffith/elm-ui/latest/Element
Element is a type alias, and it doesn't show up as a link in the signature of none below it.

Additional information

If/when this gets merged, I'll make a similar PR to dmy.elm.fr and to elm-doc-preview so that they can also benefit from the change.

I could not test this change out as I didn't know how to get the server running. I did test it however with elm-doc-preview (see my fork and branch here).

I can't think of any drawbacks to include these links, but if you do see any, please let me know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant