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
Add examples to documentation #18
Conversation
Thanks for caring. A few points here:
You can amend your commit and fix it according to my feedback, or I can change it myself later today. |
Thanks for the feedback! I'll change the example to use a function rather than ghci input, and remove the information on combining ZipArchive actions. When I was first trying to work with this library, the matter of combining multiple actions into a single action was fairly confusing, as I am not very familiar with Haskell. Perhaps it may be a good idea to include an example of working with multiple actions just to make the process more clear. |
Well, comining monadic actions is a very common thing in Haskell. I think it's safe to assume that users of the library know how to do it. You can pick a book on Haskell that explains that. It's always better to start with a book than exploring things on your own. |
Okay, I've made the changes you mentioned. Let me know if any other changes are needed. |
Add some examples of common uses of the library to the documentation.
Applied as 692079a. Your Haskell doesn't look idiomatic yet, so went ahead and added some examples of my own. I hope this decision is understandable. Thanks. |
Add some examples of common uses of the library to the documentation.