Add some documentation bits. #162
Conversation
| => a -- ^ Value to shrink toward (the value produced when the size parameter is 0) | ||
| -> a -- ^ Lower bound (the bottom of the range when the size parameter is 99) | ||
| -> a -- ^ Upper bound (the top of the range when the size parameter is 99) | ||
| -> Range a |
There was a problem hiding this comment.
😅 Nitpick: Most (if not all?) comments in this codebase end with a .— It'd be nice if we do the same also here?
There was a problem hiding this comment.
sure, i can fix all that (give me a few days). anything else?
There was a problem hiding this comment.
ah, travis. i'll look into that, too...
|
Ok, I hope this is a bit better. I am aware that my style is odd and different from the rest of the documentation. I'm happy to try harder, please let me know if i should! (-: |
|
travis-timeout. i'll push an empty commit to try again... (please let me know if you would like me to squash anything / everything.) |
| @@ -7,5 +7,26 @@ module Hedgehog.Internal.HTraversable ( | |||
|
|
|||
| -- | Higher-order traversable functors. | |||
| -- | |||
| -- This is used internally to make symbolic variables concrete given an 'Environment'. | |||
| -- | |||
| -- The type checker will ask you to write 'HTraversable' instances for your action types. If you do | |||
There was a problem hiding this comment.
I think from this line down might be better suited to a tutorial than the documentation.
If you could peel it off for now I would be happy to merge
|
Thanks! |
|
thank you! (-: |
I am open to suggestions re. style. I just hacked in what would have helped me. (-:
(That's one commit; the other is just cut & paste from #41.)