Add search terms to Command and Signature (#4980)

* Add search terms to command

* Rename Signature desc to usage

To be named uniformly with extra_usage

* Throw in foldl search term for reduce

* Add missing usage to post

* Add search terms to signature

* Try to add capnp Signature serialization
This commit is contained in:
Jakub Žádník
2022-03-27 22:25:30 +03:00
committed by GitHub
parent 0c9dd6a29a
commit 2873e943b3
32 changed files with 269 additions and 100 deletions

View File

@ -9,7 +9,7 @@ impl Plugin for Example {
// plugin is registered to nushell
vec![
Signature::build("nu-example-1")
.desc("Signature test 1 for plugin. Returns Value::Nothing")
.usage("Signature test 1 for plugin. Returns Value::Nothing")
.required("a", SyntaxShape::Int, "required integer value")
.required("b", SyntaxShape::String, "required string value")
.switch("flag", "a flag for the signature", Some('f'))
@ -18,7 +18,7 @@ impl Plugin for Example {
.rest("rest", SyntaxShape::String, "rest value string")
.category(Category::Experimental),
Signature::build("nu-example-2")
.desc("Signature test 2 for plugin. Returns list of records")
.usage("Signature test 2 for plugin. Returns list of records")
.required("a", SyntaxShape::Int, "required integer value")
.required("b", SyntaxShape::String, "required string value")
.switch("flag", "a flag for the signature", Some('f'))
@ -27,7 +27,7 @@ impl Plugin for Example {
.rest("rest", SyntaxShape::String, "rest value string")
.category(Category::Experimental),
Signature::build("nu-example-3")
.desc("Signature test 3 for plugin. Returns labeled error")
.usage("Signature test 3 for plugin. Returns labeled error")
.required("a", SyntaxShape::Int, "required integer value")
.required("b", SyntaxShape::String, "required string value")
.switch("flag", "a flag for the signature", Some('f'))