docs: clarify --full-path help text (fixes #1686)#1997
Conversation
Use "absolute path" for -p matching and "last path component" for the default, across CLI help, man page, README, and shell completion. Fixes sharkdp#1686. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Hi maintainers — gentle ping on this docs-only PR. It addresses #1686 and incorporates the review feedback from #1996 (@tmccombs): use absolute path for All CI checks are green on my side. Happy to tweak wording or close this in favor of #1996 if you prefer that PR updated instead. Thanks! |
|
Gentle ping — docs-only PR, all CI green. Ready for review when you have a moment. Thanks! |
|
Still green and ready for review. Happy to adjust wording if needed. |
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Added regression test CI re-running on the latest push — still ready for review. Thanks! |
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Pushed a follow-up: |
…1997 Co-authored-by: Cursor <cursoragent@cursor.com>
|
Friendly ping — CI green, incorporates feedback from #1996 review. Ready when you have time. Thanks! |
Scope this branch to -e/--extension only (sharkdp#1693). Full-path help clarifications remain in sharkdp#1997. Co-authored-by: Cursor <cursoragent@cursor.com>
|
|
||
| /// Help text for `--full-path` should not use ambiguous wording (#1686) | ||
| #[test] | ||
| fn test_full_path_help_text() { |
There was a problem hiding this comment.
I don't think we need a test for the help text
|
probably also worth adding an entry to the changelog |
Summary
Clarifies
--full-path/-pdocumentation so users understand:-p, patterns match the absolute path (not a relative path from the search root).Updates
src/cli.rs,doc/fd.1,README.md(prose +--helpsnapshot), zsh completion, and an internal comment insrc/config.rs.Fixes #1686.
Context
Follows feedback on #1996 from @tmccombs:
-pmatches (see also--abs-pathand--rel-pathinstead of--full-path#839).Checks
cargo fmt -- --checkcargo clippy --all-targets --all-features -- -Dwarningscargo test --lockedMade with Cursor