Skip to content
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

Remove py2 references from README #732

Merged
merged 2 commits into from Oct 3, 2022

Conversation

dannysepler
Copy link
Contributor

Since #707, I don't think pyflakes is runnable from a py2 context anymore

README.rst Outdated

* You can also invoke Pyflakes with ``python3 -m pyflakes .`` or
``python2 -m pyflakes .`` if you have it installed for both versions.
* You can invoke Pyflakes with ``python -m pyflakes .``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can be removed entirely -- or adjusted to use something like python3.10 -m pip install ... and python3.10 -m pyflakes ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of the two, I'm maybe team delete since i'd rather not add another thing for maintainers to update in the future

That said, in the setup.py it seems like pyflakes always adds some entrypoint, so what if we said:

You can invoke Pyflakes with pyflakes .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could use python3.# ... so it doesn't need updating again. the original intent of this was to show how to run it per interpreter -- there isn't really much point in showing pyflakes . though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

python3.# ... works for me!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed my mind, removing seems simpler. Also, the flake8 part of the section is implied in Design Principles so took out the "Useful tips" section

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this section is important, I want you to adjust it to still make sense but without python 2 -- no reason to throw out the baby with the bathwater

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay gave it another shot, appreciate your patience!

README.rst Outdated
* Be sure to install it for a version of Python which is compatible
with your codebase: for Python 2, ``pip2 install pyflakes`` and for
Python3, ``pip3 install pyflakes``.

* You can also invoke Pyflakes with ``python3 -m pyflakes .`` or
``python2 -m pyflakes .`` if you have it installed for both versions.
* You can invoke Pyflakes with ``python3.# -m pyflakes .``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah I meant to keep the original messaging

README.rst Outdated
Comment on lines 26 to 28
* Be sure to install it for a version of Python which is compatible
with your codebase: for Python 2, ``pip2 install pyflakes`` and for
Python3, ``pip3 install pyflakes``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this first part is still important but should be replaced with python#.# -m pip ...

Copy link
Member

@asottile asottile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asottile asottile merged commit 853cce9 into PyCQA:master Oct 3, 2022
@dannysepler dannysepler deleted the no-py2-in-readme branch October 3, 2022 20:33
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.

None yet

2 participants