extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-04-09 21:28:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

document out positional argument type (#5461)

Browse Source
This commit is contained in:
WindSoilder 2022-05-08 21:11:28 +08:00 committed by GitHub
parent 07ac3c3aab
commit a61d09222f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/nu-command/tests/format_conversions/html.rs
View File

@ -56,7 +56,7 @@ fn test_cd_html_color_flag_dark_false() {
); );
assert_eq!( assert_eq!(
actual.out, actual.out,
r"<html><style>body { background-color:white;color:black; }</style><body>Change directory.<br><br>Usage:<br> &gt; cd (path) <br><br>Flags:<br> -h, --help<br> Display this help message<br><br>Parameters:<br> (optional) path: the path to change to<br><br>Examples:<br> Change to your home directory<br> &gt; <span style='color:#037979;font-weight:bold;'>cd<span style='color:black;font-weight:normal;'> </span></span><span style='color:#037979;'>~<span style='color:black;font-weight:normal;'><br><br> Change to a directory via abbreviations<br> &gt; </span><span style='color:#037979;font-weight:bold;'>cd<span style='color:black;font-weight:normal;'> </span></span></span><span style='color:#037979;'>d/s/9<span style='color:black;font-weight:normal;'><br><br></body></html></span></span>" r"<html><style>body { background-color:white;color:black; }</style><body>Change directory.<br><br>Usage:<br> &gt; cd (path) <br><br>Flags:<br> -h, --help<br> Display this help message<br><br>Parameters:<br> (optional) path &lt;Directory&gt;: the path to change to<br><br>Examples:<br> Change to your home directory<br> &gt; <span style='color:#037979;font-weight:bold;'>cd<span style='color:black;font-weight:normal;'> </span></span><span style='color:#037979;'>~<span style='color:black;font-weight:normal;'><br><br> Change to a directory via abbreviations<br> &gt; </span><span style='color:#037979;font-weight:bold;'>cd<span style='color:black;font-weight:normal;'> </span></span></span><span style='color:#037979;'>d/s/9<span style='color:black;font-weight:normal;'><br><br></body></html></span></span>"
); );
} }
@ -71,6 +71,6 @@ fn test_no_color_flag() {
); );
assert_eq!( assert_eq!(
actual.out, actual.out,
r"<html><style>body { background-color:white;color:black; }</style><body>Change directory.<br><br>Usage:<br> &gt; cd (path) <br><br>Flags:<br> -h, --help<br> Display this help message<br><br>Parameters:<br> (optional) path: the path to change to<br><br>Examples:<br> Change to your home directory<br> &gt; cd ~<br><br> Change to a directory via abbreviations<br> &gt; cd d/s/9<br><br></body></html>" r"<html><style>body { background-color:white;color:black; }</style><body>Change directory.<br><br>Usage:<br> &gt; cd (path) <br><br>Flags:<br> -h, --help<br> Display this help message<br><br>Parameters:<br> (optional) path &lt;Directory&gt;: the path to change to<br><br>Examples:<br> Change to your home directory<br> &gt; cd ~<br><br> Change to a directory via abbreviations<br> &gt; cd d/s/9<br><br></body></html>"
); );
} }

13
crates/nu-engine/src/documentation.rs
View File

@ -87,19 +87,22 @@ fn get_documentation(
{ {
long_desc.push_str("\nParameters:\n"); long_desc.push_str("\nParameters:\n");
for positional in &sig.required_positional { for positional in &sig.required_positional {
long_desc.push_str(&format!(" {}: {}\n", positional.name, positional.desc)); long_desc.push_str(&format!(
" {} <{:?}>: {}\n",
positional.name, positional.shape, positional.desc
));
} }
for positional in &sig.optional_positional { for positional in &sig.optional_positional {
long_desc.push_str(&format!( long_desc.push_str(&format!(
" (optional) {}: {}\n", " (optional) {} <{:?}>: {}\n",
positional.name, positional.desc positional.name, positional.shape, positional.desc
)); ));
} }
if let Some(rest_positional) = &sig.rest_positional { if let Some(rest_positional) = &sig.rest_positional {
long_desc.push_str(&format!( long_desc.push_str(&format!(
" ...{}: {}\n", " ...{} <{:?}>: {}\n",
rest_positional.name, rest_positional.desc rest_positional.name, rest_positional.shape, rest_positional.desc
)); ));
} }
} }