Repository navigation
Conversation
Author
SummaryFixes #605. The Changes
|
bug-ops
force-pushed
the
fix/strip-prefix-doc
branch
from
October 13, 2026 20:39
cc89671 to
1e965af
Compare
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation accurately reflects the verified implementation behavior.
0 open findings
What changed in this PR
Clarifies documentation to match existing strip_prefix behavior.
Changes:
- Documents mismatched prefixes as ignored.
- Clarifies entries retain their unstripped relative paths.
| File | Description |
|---|---|
creation/filters.rs |
Corrects function documentation. |
creation/config.rs |
Clarifies configuration behavior. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Fixes bug-ops#605 The compute_archive_path doc incorrectly claimed that a strip_prefix mismatch returns an error. The implementation actually ignores the mismatch and uses the unstripped relative path. Updated both the fn doc comment (filters.rs) and the CreationConfig::strip_prefix field doc (config.rs) to match the actual behavior.
Jah-yee
force-pushed
the
fix/strip-prefix-doc
branch
from
October 21, 2026 19:39
1e965af to
0cdb604
Compare
This branch has not been deployed
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
Fixes #605.
The
compute_archive_pathdoc incorrectly claimed that a strip_prefix mismatch returns an error. The implementation actually ignores the mismatch and uses the unstripped relative path.Changes
filters.rs(fn doc comment)strip_prefixdoes not match the computed relative path"strip_prefixthat does not match the relative path is ignored for that entry; the unstripped relative path is used."config.rs(CreationConfig::strip_prefixfield doc)Verification
No code logic changed — documentation only.