purescript-contrib / purescript-profunctor-lenses

Pure profunctor lenses
MIT License
144 stars 51 forks source link

Improve and/or remove docstrings #144

Closed i-am-the-slime closed 1 year ago

i-am-the-slime commented 2 years ago

Description of the change On a lot of optics there were docstrings that did nothing but translate the PascalCase name of the optic into a sentence without a verb. I removed those and integrated some of the excellent explanations from https://thomashoneyman.com/articles/practical-profunctor-lenses-optics .

I didn't ask for permission so it would be great if you could accept or reject this PR @thomashoneyman .


Checklist:

thomashoneyman commented 2 years ago

@i-am-the-slime I'm perfectly happy for my descriptions to be adapted into this library!