[Haddock] [haddock] #142: Special handling of URLs in documentation
haddock
haddock at projects.haskell.org
Fri Aug 27 18:10:54 EDT 2010
#142: Special handling of URLs in documentation
---------------------------------+------------------------------------------
Reporter: KrzysztofSkrzetnicki | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: 2.7.0
Version: 2.6.0 | Keywords:
---------------------------------+------------------------------------------
It is hard to get URLs like http://example.com right in Haddock
documentation. As a result a lot of documentation contain malformed
addresses. For example see: http://hackage.haskell.org/package/random-
shuffle-0.0.2
It reads: "Random shuffle implementation, on immutable lists. Based on
`perfect shuffle' implementation by Oleg Kiselyov, available on
http:okmij.orgftpHaskell/perfect-shuffle.txt"
Because '/' conflicts with the syntax reserved for other purposes the link
is rendered as "http:okmij.orgftpHaskell/perfect-shuffle.txt". It is easy,
but cumbersome, to recreate the original link. One can also go to .cabal
file, which includes this description in this form:
{{{
description:
Random shuffle implementation, on immutable lists.
Based on `perfect shuffle' implementation by Oleg Kiselyov,
available on http://okmij.org/ftp/Haskell/perfect-shuffle.txt
}}}
My proposition is to treat urls in special way: instead of normal
processing url should yield a normal link.
I belive that only http://, https:// and ftp:// should need such special
handling, so all in all this should be fairly easy to implement.
--
Ticket URL: <http://trac.haskell.org/haddock/ticket/142>
haddock <http://www.haskell.org/haddock>
Haddock, The Haskell Documentation Tool
More information about the Haddock
mailing list