Repository navigation
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
…install third_party/README.md claimed the tree ships in wheels; a wheel built from main contains no third_party entry, and config.py resolves the tree from the working directory, so an installed wheel never finds it under site-packages. docs/SETUP.md listed the directories a wheel installation resolves without third_party/, which is one of them. dependencies/PINNED.md named harness2/third_party/, a path that does not exist.
argszero
force-pushed
the
fix/docs-third-party-wheel-claims
branch
from
October 28, 2026 10:15
ab2fd0a to
ce48bbd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three documentation lines describe where
third_party/lives, and none matches the tree:third_party/README.mdsaid the tree "is included in wheels so setup works outsidea source checkout". It is not: a wheel built from
maincontains nothird_partyentry at all, and
config.py:24-25resolvesTHIRD_PARTYfrom the working directoryfor a wheel installation, so the tree would not be found under
site-packageseven ifit shipped there.
docs/SETUP.md("Wheel installations") listed the directories a wheel installationresolves from its working directory —
.env,dependencies/,runs/— and omittedthird_party/, whichconfig.py:25resolves from there too. A reader following thatsection exactly still gets "benchmark runners and patches are not included in this copy
(7 of 7 missing under third_party/)".
dependencies/PINNED.mdnamedharness2/third_party/{jb,lab,wb}_runner/. There is noharness2/third_party; the runners are atthird_party/{jb,lab_runner,wb_runner}/.This is the same non-existent path
MANIFEST.incarried, which fix(packaging): ship third_party and the provenance manifest in the sdist #145 fixes in that file;this PR fixes the prose occurrence and leaves
MANIFEST.into fix(packaging): ship third_party and the provenance manifest in the sdist #145.The new wording is what holds on
maintoday: the tree is part of a source checkout, awheel ships the package without it, and a wheel installation looks for it in the directory
it is run from.
Measurements behind each claim
harness2/config.py:24-25:install.missing_runners()is called fromharness2/cli/setup.py:41andharness2/preflight.py:29, which is why the new SETUP.md text says setup reports themissing runners.
Related Issue
Closes #146.
Not in this PR
Whether a wheel should carry
third_party/— package data plus aconfig.pyfallbackto
site-packages— is a packaging decision for a maintainer, and a larger change thanthis one. This PR only stops the documentation from asserting behaviour the code does not
have.
Tests
python3 -m unittest discover -s tests -v→ 5 tests, OK.No new test file: the change is prose, and a test asserting a documentation sentence is
true would not bite on the code. The old claims are shown gone by grep instead: