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

Suggest linking to version specific pages on Hackage #52

Open
erantapaa opened this issue Jul 8, 2016 · 2 comments
Open

Suggest linking to version specific pages on Hackage #52

erantapaa opened this issue Jul 8, 2016 · 2 comments

Comments

@erantapaa
Copy link
Contributor

A suggestion for linking to docs on Hackage...

Currently Hayoo is linking to the "latest version" of a package on Hackage via a url which does not include a version id, e.g.:

http://hackage.haskell.org/package/persistent/docs/Database-Persist-Sql.html#v:runSqlConn

(You can search for runSql in Hayoo to have this link show up in the results.)

However, the docs for more and more recent uploads to Hackage are not getting generated - in fact, they are not even being attempted. For instance, the link above goes to a "Not Found" page because the docs for the latest version of persistent don't exist and as of now the status is still "Docs pending" - meaning that no attempts to build the docs have been made.

A solution to this problem is to have Hayoo use version specific links when linking to Hackage. The version specific link should always work because the Hoogle index file and the Haddocks pages are generated at the same time. Thus, a Hoogle index file for a specific version implies that the Haddocks for that version also exist. Moreover, Hayoo would be sending users to accurate documentation - docs which are guaranteed to match what is presented in the Hayoo search results.

For some reason more and more recently uploaded packages on Hackage do not have docs even though previous versions of the same package do have docs. The problem seems to have started around the end of November 2015.

I've created a report which provides data on the problem:

http://erantapaa.github.io/doc-status-2016-07-08/report.html

Each row represents a recent package upload for which Haddock generation has not been attempted.

If you click on the number on the left most column it will pop up an English explanation of what the data in that row means. Good examples are rows 41-45 are similar ones.

@erantapaa
Copy link
Contributor Author

fyi, here is a link to the hackage-server issue about this problem:

haskell/hackage-server#478

@gbaz
Copy link

gbaz commented Nov 2, 2016

Someone else just ran into this as well -- would be nice to fix.

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

No branches or pull requests

2 participants