More docstrings, literate commenting - Githubissues

Gozala / reducers

Library for higher-order manipulation of collections

MIT License

181 stars 8 forks source link

More docstrings, literate commenting #4

Closed gordonbrander closed 12 years ago

gordonbrander commented 12 years ago

I'm having trouble figuring out how the pieces fit together with this library. I think this is why:

Since functional libraries are built by composing more granular functions there is not the same clear distinction between API and internal that you get with OOP. This makes it harder to figure out which end to start from.
Single-verb functions are expressive when writing but not descriptive when reading. Without comments, to understand a function you must understand the internals of all the functions from which it is composed.

All this to say, I'm going to try to help out by sending pull requests with docstrings and literate-style comments. Thanks!

gordonbrander commented 12 years ago

Closing this issue in favor of #5, which has a pull request.