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

Json.Decode.lazy doc link to hint is broken #950

Closed
osteele opened this Issue Mar 13, 2018 · 2 comments

Comments

Projects
None yet
3 participants
@osteele

osteele commented Mar 13, 2018

Steps to reproduce:

Expected: A documentation page

Actual: 404 error

Changing https://github.com/elm-lang/elm-compiler/blob/master/hints/recursive-alias.md to https://github.com/elm-lang/elm-compiler/blob/master/docs/hints/recursive-alias.md in src/Json/Decode.elm fixes the issue.

The reason I'm submitting this as an Issue instead of a PR fix is that src/Json/Decode.elm doesn't exist in elm-lang's branches (master and dev). As a non-contributor, I don't know enough about the workflow to know how (or whether) this can be fixed.

If it's useful, a git patch is attached.

0001-Fix-broken-link-in-Json.Decode.lazy-docs.patch.txt

@process-bot

This comment has been minimized.

Show comment
Hide comment
@process-bot

process-bot Mar 13, 2018

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

process-bot commented Mar 13, 2018

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

@evancz

This comment has been minimized.

Show comment
Hide comment
@evancz

evancz May 22, 2018

Member

Sorry for the inconvenience on that! The link should have been:

https://github.com/elm-lang/elm-compiler/blob/0.18.0/hints/recursive-alias.md

So that it could survive future code changes. I don't think there is a way to fix it retroactively, but we will be doing things in a different way in the next release such that this should not happen again!

Member

evancz commented May 22, 2018

Sorry for the inconvenience on that! The link should have been:

https://github.com/elm-lang/elm-compiler/blob/0.18.0/hints/recursive-alias.md

So that it could survive future code changes. I don't think there is a way to fix it retroactively, but we will be doing things in a different way in the next release such that this should not happen again!

@evancz evancz closed this May 22, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment