search

Lysxia / test-monad-laws

QuickCheck properties for monad classes
MIT License
7 stars 1 forks source link

Descriptions of laws being checked in Haddocks #10

Closed kozross closed 3 years ago

kozross commented 3 years ago

This is meant to (partially) address #8, and define the format for such. I've added natural language descriptions in addition to equations, as I think having both helps aid intuition. I'm not wedded to the chosen format, and am willing to modify these (as well as potentially write the rest).

Lysxia commented 3 years ago

Note: I'm not opposed to adding gitignore, but you can also have global rules that apply to all repositories in your $HOME/.config/git/ignore (location configurable by setting core.excludeFiles in .gitconfig, see also man gitignore).

Lysxia commented 3 years ago

This looks good to me! Are you planning to add more in this PR?

My main suggestion would be to make it so the constants are hyperlinked:

-- @
-- 'callCC' ('const' x) = x
-- @
kozross commented 3 years ago

@Lysxia I can certainly do that if nobody else is picking this up. I'll make the fix you suggested with the hyperlinks - didn't know Haddocks can do that!

solomon-b commented 3 years ago

@kozross I can do this in a few hours if you like.

Lysxia commented 3 years ago

@kozross anything you wanted to add before merging this?

kozross commented 3 years ago

Nope, I think this covers everything.