Skip to content

Add warnings on README for python 2.7 compatibility - #6

Open
karankurani wants to merge 3 commits into
vollib:masterfrom
karankurani:master
Open

Add warnings on README for python 2.7 compatibility#6
karankurani wants to merge 3 commits into
vollib:masterfrom
karankurani:master

Conversation

@karankurani

Copy link
Copy Markdown

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.

@lbrichards

lbrichards commented Jun 6, 2023 via email

Copy link
Copy Markdown
Contributor

@karankurani

karankurani commented Jun 6, 2023

Copy link
Copy Markdown
Author

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.

@lbrichards

lbrichards commented Jun 7, 2023 via email

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants