Skip to content

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

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.

Sign up for GitHub

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

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

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

wants to merge 1 commit into 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).

@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.

@rgommers rgommers force-pushed the add-wheel-flag-to-build branch from 717af2c to 0e1ee55 Compare May 2, 2025 12:31
rgommers
rgommers commented May 2, 2025
View reviewed changes
docs/how-to-guides/config-settings.rst Outdated
@@ -34,6 +34,7 @@ the ``-C`` short command line option:

.. code-block:: console

$ # note: pip >=23.1 also accepts -C instead of --config-settings
Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmm, stray tab characters in this file messing things up

@rgommers
DOC: minor tweak to docs on invoking pip/build
cf6e2a7 
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).

Also fix up stray tab characters in how-to-guides/config-settings.rst
@rgommers rgommers force-pushed the add-wheel-flag-to-build branch from 0e1ee55 to cf6e2a7 Compare May 2, 2025 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rgommers @dnicolodi