tandav / pipe21

Simple functional pipes for python
https://tandav.github.io/pipe21
MIT License
18 stars 1 forks source link

`pipe` instead of `pipe21` in examples #1

Closed ricardo-reis-1970 closed 3 years ago

ricardo-reis-1970 commented 3 years ago

Privet!

I found pipe21 while checking on pipe on pypi and trying to find out something more usable. This pipe21 is way better and I think it only lacks a bit of documentation (which I'd be happy to start putting together!)

However, after having installed both I noticed that the examples here all mention pipe instead of pipe21 in the imports. Without pipe installed, this just gives a ModuleNotFoundError. With pipe installed, this goes to it, instead.

If one could vote for deprecation of stale libs and name release, I would totally do it. This is small, smart and I'll definitely be using it, as I am a fierce advocate for Functional Programming. But the examples must all be updated too (as you did in rename pipe -> pipe21), otherwise they won't work and adoption could be compromised.

Let me know what I can do to help. Ricardo

tandav commented 3 years ago

Hi Ricardo, thank you for your feedback! You are right, there is definitely a typo in README. The lib was named pipe before i published it to pypi. Then I realized that this name is already used and published it as pipe21, but forgot to update the README examples. 😓 (there's no dependency on pipe lib that you mentioned)

I've updated all the pipe to pipe21, so now examples should not raise ModuleNotFoundError.

You are right, docs is quite poor now, only describing main methods. I'll try to add more examples and descriptions for all methods.

The lib is very small (less than 100 lines single file). All available methods are here. I think docs should describe / have examples to all of them. If you want to add some docs/examples/or new functions you're welcome to open PR/issue.

tandav commented 3 years ago

I've created a file with a reference for all available methods, I'll try to fill it soon. Feel free to edit it if you want!