Mark all pages for a deprecated package as deprecated

[alexanderkjeldaas]

When a package is deprecated, it should not be necessary to go to the 'contents' section to see that it is deprecated.

The warning should be at the top of every page.

[alexanderkjeldaas]

Here is an example the following link is the first result for the query 'cprg hackage' on google. The package is deprecated.

http://hackage.haskell.org/package/crypto-random-api-0.2.0/docs/Crypto-Random-API.html

But that is nowhere to be seen, only on the main page:

http://hackage.haskell.org/package/crypto-random-api-0.2.0

[Fuuzetsu]

Here is an example the following link is the first result for the query 'cprg hackage' on google. The package is deprecated.

http://hackage.haskell.org/package/crypto-random-api-0.2.0/docs/Crypto-Random-API.html

This is a module, not a package. There is nothing in this module that's deprecated.

But that is nowhere to be seen, only on the main page:

http://hackage.haskell.org/package/crypto-random-api-0.2.0

Hackage generates this page, not Haddock.

You can deprecate modules and Haddock will render that, such as seen at http://hackage.haskell.org/package/attoparsec-0.12.1.2/docs/Data-Attoparsec.html

Haddock has no notion of a deprecated package, only functions and modules (which may or may not be re-exported from other packages). Personally I think it makes sense to only show deprecation message on the package page (your first link) because that's what you're deprecating. Even if you spliced that info into modules, it'd just be noise.

Either way, we don't do package deprecation, Hackage does: there is no such concept on package level. You can see this when you go into maintainer section of any package you own on Hackage. You can try opening a ticket with them but I don't think it will get far for due to amount of effort required for a rather questionable feature.

[sol]

I agree that this would mostly be a Hackage feature. If somebody wants to address this on the Hackage front we could still extend Haddock to allow to hook in deprecation messages if required.

[Fuuzetsu]

I'm not sure how that'd be achieved as deprecation of a package can only happen after the docs are generated unless we did something shady like call out to the contents page from JS…

Oh, I suppose Hackage can regenerate docs. A flag on our end would be possible I guess.

[sol]

Oh, I suppose Hackage can regenerate docs. A flag on our end would be possible I guess.

Yes, that is what I was thinking. But it's up to who ever wants to tackle this.

[alexanderkjeldaas]

The word 'deprecated' might technically be wrong, but some indication that the documentation is currently invalid, for various reasons such as:

• This version is known to be buggy
• The package is deprecated
• The package is outdated

Seems like a good feature to have. I've opened an issue on the hackage server as suggested.

[sol]

@alexanderkjeldaas I agree and hackage-server is the right place to address this.