document out positional argument type (#5461)

This commit is contained in:
WindSoilder
2022-05-08 21:11:28 +08:00
committed by GitHub
parent 07ac3c3aab
commit a61d09222f
2 changed files with 10 additions and 7 deletions

View File

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