search

tweag / ormolu

A formatter for Haskell source code
https://ormolu-live.tweag.io
Other
958 stars 83 forks source link

Broken link in Hackage README #416

Closed david-christiansen closed 5 years ago

david-christiansen commented 5 years ago

On Hackage, at least at the time of writing, there is a link with the text "the design document" that points at https://hackage.haskell.org/package/ormolu-0.0.1.0/ormolu-0.0.1.0/src./DESIGN.md#cpp . This gives a 404.

mrkkrp commented 5 years ago

The readme is meant to be read on GitHub, not on Hackage. Hackage just tries to render readme files as a courtesy but it 1) cannot do it properly for things like tables 2) will not get the links to the contents of the repo right.

We could make all links absolute, although this is somewhat ugly.

mboes commented 5 years ago

Better to avoid users' surprise than to be ever so slightly technically more elegant. If the README is redistributed on other platforms independently of other documents, then including absolute references is the right thing to do.

david-christiansen commented 5 years ago

Thanks for looking at it!

mrkkrp commented 5 years ago

Resolved in f83f6fd.

david-christiansen commented 5 years ago

That was quick! Thanks!