documentation is missing

[jwaldmann]

I known generally what "hash consing" is
(and that's why I think I might want to use this package)
but I don't see what is the (implied) contract for this implementation:
It looks like I need to write some instances
(to make my type "internable") but what properties should they have,
and what properties of the functions defined in the package
do I get in return?

http://thread.gmane.org/gmane.comp.lang.haskell.cafe/105169/focus=105192

[ekmett]

I'd be happy to take documentation patches.

When this package was first written I'd hoped I could garbage collect the entries in the hash cons tables. When that didn't work (it mostly worked, but occasionally failed spectacularly, but only in very large test cases) I trimmed it down to the current form, which works, but leaks more memory than I'd like. At that time, I mostly lost interest and have mainly maintained it because it has a number of users, but it hasn't received nearly the level of attention it should.

[Blaisorblade]

@jwaldmann are you still interested? I can write docs, and if somebody helps I can get them in shape for merging.

I'm also probably going to use this, and I'm trying to learn to use the library and reverse-engineer documentation from the code and the examples.

But I've never documented a Haskell library, so I'd like somebody other than Edward to review my docs first.

Would you volunteer to review them?

[Blaisorblade]

I've started work on this at https://github.com/Blaisorblade/intern/tree/topic/docs.

[jwaldmann]

@Blaisorblade : interesting, I will look into it (for details, see email).

[Blaisorblade]

@jwaldmann : thanks!