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

Fix conflicting classification of install #1572

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

covracer
Copy link

@covracer covracer commented Jul 12, 2024

Lines 21 to 23 state that the install command must not be run anymore.


📚 Documentation preview 📚: https://python-packaging-user-guide--1572.org.readthedocs.build/en/1572/

The first paragraph says the command must not be run anymore.
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Thanks for the change! None of the commands should be run anymore. I think that this just states for the record that things still exist, but the document does not provide suggestions on how to deal with them right now. Removing one but leaving the others doesn't feel right. Not sure we'd want it in this form.

@sinoroc
Copy link
Contributor

sinoroc commented Jul 13, 2024

@webknjaz for all the commands in this one particular list we do not make any recommendation for an alternative solution, but the issue pointed here is that we actually do have a recommendation for install (python -m pip install .). So install does not need to be listed here.

So while the text in the body of the commit message is incorrect, the change itself is correct.

@sinoroc
Copy link
Contributor

sinoroc commented Aug 13, 2024

@webknjaz Can we get this merged? This is a straightforward fix. I was the one to write this page and introduce this mistake. I am sure this fix is correct.

@covracer covracer requested a review from webknjaz August 17, 2024 13:46
@covracer
Copy link
Author

covracer commented Aug 17, 2024

Thanks for the change! None of the commands should be run anymore. I think that this just states for the record that things still exist, but the document does not provide suggestions on how to deal with them right now. Removing one but leaving the others doesn't feel right. Not sure we'd want it in this form.

I don't understand.

Lines 21 to 26 list 4 commands as "MUST NOT be run": install, develop, sdist, bdist_wheel.

Lines 121 through 153 lists 25 commands as "remaining" or no recommended replacement.

I'm trying to fix the one overlapping element between the two lists.

I've updated the pull request description to be more specific. Please let me know if other changes are necessary to make the clarification acceptable.

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.

4 participants