From cf0877bf72b7a6028f6e0f2e7fdfd4b449f9b5ef Mon Sep 17 00:00:00 2001
From: pwygab <88221256+merelymyself@users.noreply.github.com>
Date: Fri, 1 Jul 2022 01:51:41 +0800
Subject: [PATCH] ensure `required` positionals don't show up as `optional`
 when `help` (#5916)

* ensure `required` positionals show up as `required` when `help`

* moves it to the older format

* standardises across optional and required parameters
---
 crates/nu-engine/src/documentation.rs | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/crates/nu-engine/src/documentation.rs b/crates/nu-engine/src/documentation.rs
index 92f3bbe26d..a93e6d61bb 100644
--- a/crates/nu-engine/src/documentation.rs
+++ b/crates/nu-engine/src/documentation.rs
@@ -89,12 +89,13 @@ fn get_documentation(
     {
         long_desc.push_str("\nParameters:\n");
         for positional in &sig.required_positional {
-            long_desc.push_str(&format!(
-                "  (optional) {} <{:?}>: {}\n",
+            let _ = writeln!(
+                long_desc,
+                "  {} <{:?}>: {}",
                 positional.name,
                 document_shape(positional.shape.clone()),
                 positional.desc
-            ));
+            );
         }
         for positional in &sig.optional_positional {
             let _ = writeln!(