[Haskell-cafe] Please fix documentation for you Hackage packages!

Erik Hesselink hesselink at gmail.com
Mon Jan 6 16:34:50 UTC 2014

That's a nice script. I've forked it [0] and fixed two issues: the
matching on Version is now case insensitive, and it uses --format
instead of -H to also work on MacOS/BSD tar. Now my package has
documentation! All the links in it are wrong, though. Some regex
replace might be able to fix that.


[0] https://gist.github.com/hesselink/8285419

On Mon, Jan 6, 2014 at 4:55 PM, Niklas Hambüchen <mail at nh2.me> wrote:
> Yes, it does make a lot of sense in these cases.
> It is not tedious. This Python script automates it for you:
>   https://gist.github.com/nh2/8284831
> (The original block post also contains a minimal script.)
> Maybe we can add a command `cabal upload-docs` that does this?
> On Mon 06 Jan 2014 16:47:57 CET, Erik Hesselink wrote:
>> In some cases it actually makes sense. For example, my kqueue package
>> is in the list above. It is a binding to a MacOS/BSD C library, and
>> the hackage build bot runs on linux. So I should actually upload the
>> documentation...
>> Erik
>> On Mon, Jan 6, 2014 at 4:35 PM, Sven Panne <svenpanne at gmail.com> wrote:
>>> To be honest, I actively encourage people to *not* fix their package
>>> documentation manually. This is tedious, error-prone, and I bet there
>>> will be tons of packages then where the actual code and documentation
>>> will disagree (worse than no documentation at all), we're humans after
>>> all. Fixing Hackage is the way to go, not some guaranteed-to-fail
>>> crowd-sourcing... :-/
>>> _______________________________________________
>>> Haskell-Cafe mailing list
>>> Haskell-Cafe at haskell.org
>>> http://www.haskell.org/mailman/listinfo/haskell-cafe

More information about the Haskell-Cafe mailing list