Add warnings on README for python 2.7 compatibility - #6
Conversation
|
Thanks for this feedback. I'm wondering if you have seen this https://vollib.org/source.html?
We recently gave the vollib.org <http://vollib.org/> website a makeover. I now notice that some pieces might be confusing or incomplete.
My hope is that Python programmers will prefer py_vollib, which is Python 3 compatible. I will try to make that clear. I'm thinking to retire the Python 2.7 (SWIG) version and rename py_vollib to simply "vollib."
Best regards,
Larry
On Jun 5, 2023, at 9:27 PM, Karan Kurani ***@***.***> wrote:
It is not immediately clear from the README that this library is only compatible with python 2.7 and not python 3.
It is also not obvious where the updated version of this library is.
I added two warnings (one on top and one near the pip install section) to point to the updated library.
You can view, comment on, or merge this pull request online at:
#6
Commit Summary
e7a2196 <e7a2196> Update README.MD to include python 3 installation instructions
58907d0 <58907d0> Update README.MD to give link to the updated library
7a1d64e <7a1d64e> Update README.MD - added another warning near install instructions to point to updated library
File Changes (1 file <https://github.com/vollib/vollib/pull/6/files>)
M README.MD <https://github.com/vollib/vollib/pull/6/files#diff-01e6d9ffed056a02cae8d8a0ec5d476a64d017bf85c0d5a94bb23ca21f33f5aa> (6)
Patch Links:
https://github.com/vollib/vollib/pull/6.patch
https://github.com/vollib/vollib/pull/6.diff
—
Reply to this email directly, view it on GitHub <#6>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACUBAPBCYOJ2NT3776MNVWLXJXGCDANCNFSM6AAAAAAY24U6RE>.
You are receiving this because you are subscribed to this thread.
|
|
Hey Larry, Yes. I eventually figured it out based on the website and a comment issue tracker here. The reason I did not get to the website first is that when I googled for libraries - the github repo was the first link and I was specifically looking for github repos to read the README. Like me, I think a bunch of users will land on the github repo instead of the website via google. And it will be helpful to have this updated info in the README itself. Second, the website uses the header "Python". I totally missed it that this was for "Python 3". Perhaps changing the header will help. If you want me to update the PR to follow a certain format please let me know and I will modify it. FWIW - I totally support retiring the older version. Don't see a reason to keep on supporting it. |
|
Hi Karan,
Let me go ahead and merge your PR, plus make a few tweaks myself in both the README.md as well as the website. Thanks again for giving me the heads up about the points of confusion.
Best regards,
Larry
On Jun 6, 2023, at 3:07 PM, Karan Kurani ***@***.***> wrote:
Hey Larry,
Yes. I eventually figured it out based on the website and a comment issue tracker here <vollib/lets_be_rational#3>.
The reason I did not get to the website first is that when I googled for libraries - the github repo was the first link and I was specifically looking for github repos to read the README. Like me, I think a bunch of users will land on the github repo instead of the website via google. And it will be helpful to have this updated info in the README itself.
Second, the website uses the header "Python". I totally missed it that this was for "Python 3". Perhaps changing the header will help.
If you want me to update the PR to follow a certain format please let me know and I will modify it.
—
Reply to this email directly, view it on GitHub <#6 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACUBAPG7CGG4NA6DGFGMNNDXJ3CJNANCNFSM6AAAAAAY24U6RE>.
You are receiving this because you commented.
|
It is not immediately clear from the README that this library is only compatible with python 2.7 and not python 3.
It is also not obvious where the updated version of this library is.
I added two warnings (one on top and one near the pip install section) to point to the updated library.