Skip to content

Commit

Permalink
Changed category for panic and added search terms and examples (nus…
Browse files Browse the repository at this point in the history
…hell#13707)

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

# User-Facing Changes
See above
  • Loading branch information
ayax79 authored Aug 27, 2024
1 parent 1128df2 commit 71ced35
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions crates/nu-command/src/misc/panic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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,
}]
}
}

0 comments on commit 71ced35

Please sign in to comment.