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

DOC: minor tweak to docs on invoking pip/build #707

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rgommers
Copy link
Contributor

Addresses a comment on gh-704, where a user got tripped up by python -m build building an sdist first (and that's typically not what you want).

Addresses a comment on issue 704, where a user got tripped up
by `python -m build` building an sdist first (and that's typically
not what you want).
@rgommers rgommers added the documentation Improvements or additions to documentation label Nov 14, 2024
@dnicolodi
Copy link
Member

We have several other example python -m build invocation in the documentation? Should we change them to python -m build --wheel or is this the time to add that "Creating a binary distribution" we have been talking about and have a note there about the pypa/build unexpected behavior?

@rgommers
Copy link
Contributor Author

rgommers commented Dec 5, 2024

I think we should add --wheel to all other instances of python -m build. The default is useful only for a single CI job or a release of a pure Python package; I can't think of any time I regularly did not add --wheel or -wnx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants