search

elm / package.elm-lang.org

website for browsing packages and exploring documentation
https://package.elm-lang.org/
BSD 3-Clause "New" or "Revised" License
293 stars 113 forks source link

Incorrect link to http://package.elm-lang.org/packages/rluiten/elm-date-extra/latest/Date-Format #214

Closed rofrol closed 7 years ago

rofrol commented 7 years ago

When I'm on page http://package.elm-lang.org/packages/rluiten/elm-date-extra/1.1.0/Date-Format and click link in page presented as:

The latest version of this package is 8.1.2

I will see:

problem with parameter 'version': Must have format MAJOR.MINOR.PATCH (e.g. 1.0.2)

Correct link should be http://package.elm-lang.org/packages/rluiten/elm-date-extra/latest/Date-Extra-Format

process-bot commented 7 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.

trytriangles commented 7 years ago

This is a bug with a few areas of the documentation. The same happens on Html.App for 1.1.0.

When you look up documentation for an outdated package, the warning will always point you to the documentation for the latest version. But instead of just linking to the root documentation for the package, it points you to the latest version of the same module you're looking at. If that module has been removed from the package, you get this error. Date.Format was replaced by Date.Extra.Format and Html.App no longer exists, so both of those break.

This is a bit of a problem, as old documentation pages turn up as high Google results with regularity and are still linked to all over the place (the StackOverflow documentation for the Elm Architecture points to the Html.App module all over the place right now, I'm going to update it).

bobwhitelock commented 7 years ago

Related to this issue, the same error message can occur from other broken links, such as from invalid links within a package documentation itself like in https://github.com/elm-community/elm-test/pull/106. It would probably make sense to 404 instead in this case.

JoshTGreenwood commented 7 years ago

I just stumbled across this as well, here's a gif:

docs breaking

martinmodrak commented 7 years ago

This seems to be a duplicate of #195 (I however do not have rights to mark it as such)