Skip to content

Commit 9a658f9

Browse files
committed
docs(unstable): Add completion feedback information
1 parent 9101762 commit 9a658f9

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/doc/src/reference/unstable.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1695,6 +1695,23 @@ This feature moves the handwritten completion scripts to Rust native, making it
16951695
easier for us to add, extend and test new completions. This feature is enabled with the
16961696
nightly channel, without requiring additional `-Z` options.
16971697

1698+
Areas of particular interest for feedback
1699+
- Arguments that need escaping or quoting that aren't handled correctly
1700+
- Inaccuracies in the information
1701+
- Bugs in parsing of the command-line
1702+
- Arguments that don't report their completions
1703+
- If a known issue is being problematic
1704+
1705+
Feedback can be broken down into
1706+
- What completion candidates are reported
1707+
- Known issues: [#14520](https://github.com/rust-lang/cargo/issues/14520), [`A-completions`](https://github.com/rust-lang/cargo/labels/A-completions)
1708+
- [Report an issue](https://github.com/rust-lang/cargo/issues/new) or [discuss the behavior](https://github.com/rust-lang/cargo/issues/14520)
1709+
- Shell integration, command-line parsing, and completion filtering
1710+
- Known issues: [clap#3166](https://github.com/clap-rs/clap/issues/3166), [clap's `A-completions`](https://github.com/clap-rs/clap/labels/A-completion)
1711+
- [Report an issue](https://github.com/clap-rs/clap/issues/new/choose) or [discuss the behavior](https://github.com/clap-rs/clap/discussions/new/choose)
1712+
1713+
When in doubt, you can discuss this in [#14520](https://github.com/rust-lang/cargo/issues/14520) or on [zulip](https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo)
1714+
16981715
### How to use native-completions feature:
16991716
- bash:
17001717
Add `source <(CARGO_COMPLETE=bash cargo +nightly)` to your .bashrc.

0 commit comments

Comments
 (0)