Merge pull request #2567 from carapace-sh/doc-clap-bridge

doc: add notice about clap-rs/clap#3166
carapace-sh · Oct 24, 2024 · 17e73ab · 17e73ab
2 parents 50e3839 + edb5937
commit 17e73ab
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/src/bridges.md b/docs/src/bridges.md
@@ -18,7 +18,7 @@ Currently available bridges:
 - [argcomplete](https://github.com/kislyuk/argcomplete)
 - [bash](https://www.gnu.org/software/bash/)
 - [carapace](https://github.com/carapace-sh/carapace)
-- [clap](https://github.com/clap-rs/clap)
+- [clap](https://github.com/clap-rs/clap) (needs [clap-rs/clap#3166](https://github.com/clap-rs/clap/issues/3166))
 - [click](https://github.com/pallets/click)
 - [cobra](https://github.com/spf13/cobra)
 - [complete](https://github.com/posener/complete)

diff --git a/docs/src/spec/bridge.md b/docs/src/spec/bridge.md
@@ -63,6 +63,8 @@ completion:
   positionalany: ["$carapace.bridge.Clap([dynamic])"]
 ```
 
+> needs [clap-rs/clap#3166](https://github.com/clap-rs/clap/issues/3166)
+
 ### Click
 
 [pallets/click] based commands can be bridged with the [`bridge.Click`] macro: