search

elm / elm-lang.org

Server and client code for the Elm website.
http://elm-lang.org/
BSD 3-Clause "New" or "Revised" License
1.99k stars 366 forks source link

Broken link in documentation #637

Closed mxgrn closed 8 years ago

mxgrn commented 8 years ago

This line in the code: https://github.com/elm-lang/elm-lang.org/blob/master/src/pages/docs/syntax.elm#L238 seemingly results in a bad URL on the documentation page: http://package.elm-lang.org/packages/elm-lang/core/latest/Basics#> (missing the second ">").

process-bot commented 8 years ago

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 commented 8 years ago

Does anyone know the fix? Is this something about the markdown parser that >> means something?

OvermindDL1 commented 8 years ago

Seems like a bug in the markdown parser that elm-lang.org uses to generate as it works at: http://spec.commonmark.org/dingus/?text=Relatedly%2C%20%5B%60(%3C%3C)%60%5D(http%3A%2F%2Fpackage.elm-lang.org%2Fpackages%2Felm-lang%2Fcore%2Flatest%2FBasics%23%3C%3C)%0Aand%20%5B%60(%3E%3E)%60%5D(http%3A%2F%2Fpackage.elm-lang.org%2Fpackages%2Felm-lang%2Fcore%2Flatest%2FBasics%23%3E%3E)%0Aare%20function%20composition%20operators.

You could 'try' escaping it with \ maybe, although I'm not sure how that will be handled in a url in the parser that is used.

evancz commented 8 years ago

Can someone test? It is just using elm-markdown.

OvermindDL1 commented 8 years ago

I happen to be using elm-markdown in my big project so let me test. Yes, elm-markdown is broken, it is parsing it wrong and one of the > is vanishing. However I did find a work-around after trying a few things. Apparently elm-markdown does not support escaping inside urls (not sure if that is spec'd or not even), however putting three > did work, thus [test](http://package.elm-lang.org/packages/elm-lang/core/latest/Basics#>>>) got turned into a string of 'test' with a link of http://package.elm-lang.org/packages/elm-lang/core/latest/Basics#>>

So a hack-of-a-fix until elm-markdown is fixed is just to use http://package.elm-lang.org/packages/elm-lang/core/latest/Basics#>>> with the three > at the end instead of just two, with maybe a note to fix it once elm-markdown is fixed. :-)

evancz commented 8 years ago

Very weird, but that'll work! Do you mind doing a PR?

OvermindDL1 commented 8 years ago

Done: https://github.com/elm-lang/elm-lang.org/pull/641