api: improve reST formating

This commit is contained in:
Dietmar Maurer 2021-02-09 08:53:08 +01:00
parent 4c741b67c7
commit 4efbdd79ef

View File

@ -128,13 +128,15 @@ pub fn get_property_description(
if format == DocumentationFormat::ReST {
let mut text = match style {
ParameterDisplayStyle::Config => {
format!(":``{} {}{}``: ", name, type_text, default_text)
// reST definition list format
format!("``{}`` : ``{}{}``\n ", name, type_text, default_text)
}
ParameterDisplayStyle::Arg => {
format!(":``--{} {}{}``: ", name, type_text, default_text)
// reST option list format
format!("``--{}`` ``{}{}``\n ", name, type_text, default_text)
}
ParameterDisplayStyle::Fixed => {
format!(":``<{}> {}{}``: ", name, type_text, default_text)
format!("``<{}>`` : ``{}{}``\n ", name, type_text, default_text)
}
};