Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No documentation #2

Closed
bkaestner opened this issue Feb 12, 2016 · 2 comments
Closed

No documentation #2

bkaestner opened this issue Feb 12, 2016 · 2 comments

Comments

@bkaestner
Copy link

Your code doesn't contain any documentation so far, except for some comments in the examples.

(This is probably going to be a long-lead issue)

@I3ck
Copy link
Owner

I3ck commented Feb 12, 2016

b79b563
thanks again

@I3ck I3ck closed this as completed Feb 12, 2016
@bkaestner
Copy link
Author

Err, Haddock documentation. A more complete readme is a good start, but there's still no documentation in the code itself, e.g.

-- | Checks whether @hasBB1@ is contained in @hasBB2@ or vice versa.
-- It's a shorthand for two consecutive 'doContain' checks with flipped arguments
-- and is therefore symmetric and reflexive:
--
-- prop> doContain x y = doContain y x
-- prop> doContain x x = True
doContain :: (HasBoundingBox a, HasBoundingBox b) => a -> b -> Bool

Depending on the actual detail of the documentation (and examples), libraries like doctest can then test your code by checking the properties and examples of your code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants