Data.List documentation improvements

David House dmhouse at gmail.com
Thu Dec 14 14:22:18 EST 2006


On 05/12/06, Simon Marlow <simonmarhaskell at gmail.com> wrote:
> I'm a bit concerned that the concept of "the code for a function" is not as
> simple as it seems.  Including just the code for the function itself often won't
> be useful, because it might be something like
>
>    myFunction x y z = myFunction' x y z []
>
> so then do we include the transitive closure of code referenced by the function?
>   What if we refer to something in a different file, or scattered around the
> current file?  What about CPP?  Presumably functions that are documented
> elsewhere should be rendered as links.  etc. etc.

My vote for myFunction would be to just show the RHS, but link
myFunction' to its own documentation and source link. A nice touch
would be to automatically expand the source section of the target
function if the user followed a link from another function's source.

-- 
-David House, dmhouse at gmail.com


More information about the Libraries mailing list