Skip to content

docs: document wheel pack --local-version - #699

Open
hxperl wants to merge 1 commit into
pypa:mainfrom
hxperl:docs-pack-local-version
Open

hxperl wants to merge 1 commit into
pypa:mainfrom
hxperl:docs-pack-local-version

Conversation

@hxperl

@hxperl hxperl commented Sep 15, 2026

Copy link
Copy Markdown

wheel pack --help lists --local-version; docs/reference/wheel_pack.rst does not. #694 added the option and a news entry, but never touched the reference page.

$ wheel pack --help
usage: wheel pack [-h] [--dest-dir DEST_DIR] [--build-number BUILD_NUMBER]
                  [--local-version LOCAL_VERSION]
                  directory

Checked the wording against the behaviour: --local-version=foo gives demo-1.0+foo-py3-none-any.whl, --local-version="" gives demo-1.0-py3-none-any.whl. Docs build adds no new warning; pytest 74 passed.

Not bundled, happy to send separately: wheel_convert.rst omits -v/--verbose, and its failure example shows an error string the command cannot actually produce — but which output you'd rather document there is your call, not mine.

pypa#694 added the option and a news entry but not the reference page.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019zkQEGBfqqomF5tanu383Q
@codecov

codecov Bot commented Sep 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.45%. Comparing base (b25c3c2) to head (e070c6a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #699   +/-   ##
=======================================
  Coverage   63.45%   63.45%           
=======================================
  Files          15       15           
  Lines        1267     1267           
=======================================
  Hits          804      804           
  Misses        463      463           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@agronholm agronholm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good. The only thing that caught my eye is that last part about passing an empty string. The --build-number option works the same way, and that doesn't have any matching text there. This feels odd, and maybe we should fix both for the sake of consistency. Also, perhaps it would be good to explain how to pass an empty string on the command line?

@agronholm

Copy link
Copy Markdown
Contributor

And yes, I would accept another PR for wheel convert.

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