Changed category for panic and added search terms and examples (#13707)

# Description
Cosmetic changes around `panic` command. Changed category, added search
terms, and examples.

# User-Facing Changes
See above
This commit is contained in:
Jack Wright 2024-08-27 16:58:05 -07:00 committed by GitHub
parent 1128df2d29
commit 71ced35987
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -9,16 +9,22 @@ impl Command for Panic {
}
fn description(&self) -> &str {
"Executes a rust panic, useful only for testing."
"Causes nushell to panic."
}
fn search_terms(&self) -> Vec<&str> {
vec!["crash", "throw"]
}
fn signature(&self) -> nu_protocol::Signature {
Signature::build("panic")
.input_output_types(vec![(Type::Nothing, Type::table())])
// LsGlobPattern is similar to string, it won't auto-expand
// and we use it to track if the user input is quoted.
.optional("msg", SyntaxShape::String, "The glob pattern to use.")
.category(Category::Experimental)
.input_output_types(vec![(Type::Nothing, Type::Nothing)])
.optional(
"msg",
SyntaxShape::String,
"The custom message for the panic.",
)
.category(Category::Debug)
}
fn run(
@ -35,6 +41,10 @@ impl Command for Panic {
}
fn examples(&self) -> Vec<Example> {
vec![]
vec![Example {
description: "Panic with a custom message",
example: "panic 'This is a custom panic message'",
result: None,
}]
}
}