docs(pip): fix external dependency output structure#1514
docs(pip): fix external dependency output structure#1514derasdf merged 1 commit intohermetoproject:mainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in docs/pip.md to reflect changes in the storage and naming conventions for external dependencies, which are now stored flat in the deps/pip/ directory with filenames including checksum hashes. The review feedback identifies an opportunity to improve the documentation's formatting by removing redundant consecutive blank lines.
harshitbansal184507
force-pushed
the
pip-docs/external-deps
branch
from
6bc1ee4 to
05c5415
Compare
There was a problem hiding this comment.
s/docs(pip): fix external dependency output structure/docs: pip: Fix external dependency output structure/ - convention is colon-separated prefixes, capitalized verb. Double space typo too :)
Commit body is missing the WHY. When was this introduced? How did you find it? (7d06928 changed this ~10 months ago.) Put it in the commit message.
Also: s/but is actually stored/but they are actually stored/
nitpick: 3 open PRs (#1419, #1428, #1514), two for a month. I'd suggest slowing down and polishing each PR before moving to the next, it makes reviews smoother for everyone :)
Yes, but trivial changes, especially to docs like this one, is not a problem IMO, docs should always be a first-class citizen. That said, yes, the PR pool is still massive and we'll only slowly going to chew through it. |
harshitbansal184507
force-pushed
the
pip-docs/external-deps
branch
2 times, most recently
from
d28f585 to
f72c0f0
Compare
The docs showed external deps stored in subdirectories (e.g. external-dockerfile-parse/), but they are actually stored flat in deps/pip/ alongside PyPI deps. This was changed in 7d06928. Found the discrepancy while working on uv integration, where I was mirroring hermeto's output directory structure. Updated the directory tree and description to match actual behavior. Signed-off-by: Harshit Bansal <harshitbansal184507@gmail.com>
harshitbansal184507
force-pushed
the
pip-docs/external-deps
branch
from
f72c0f0 to
e8d9eea
Compare
3 participants
The docs showed external deps stored in subdirectories (external-dockerfile-parse/), but is stored flat in deps/pip/ alongside PyPI deps. Updated the directory tree and description