Skip to content

Commit 59e9fa8

Browse files
committed
fix(vimdoc): wrap ---@return type in parenthesis instead of curly brackets
1 parent 3a2f125 commit 59e9fa8

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

src/vimdoc/func.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ impl ToDoc for FuncDoc {
9494
for entry in &n.returns {
9595
if let Layout::Mini(n) = s.layout {
9696
table.add_row([format!(
97-
"{{{}}} {}",
97+
"({}) {}",
9898
entry.ty,
9999
if entry.desc.is_empty() {
100100
entry.name.clone().unwrap_or_default()
@@ -104,7 +104,7 @@ impl ToDoc for FuncDoc {
104104
)]);
105105
} else {
106106
table.add_row([
107-
format!("{{{}}}", entry.ty),
107+
format!("({})", entry.ty),
108108
if entry.desc.is_empty() {
109109
entry.name.clone().unwrap_or_default()
110110
} else {

tests/basic.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ U.sub({this}, {that}) *U.sub*
256256
{that} (number) Second number
257257
258258
Returns: ~
259-
{number} Some secret number that
259+
(number) Some secret number that
260260
we don't know about
261261
262262
Usage: ~
@@ -273,8 +273,8 @@ U.magical({this}, {that}) *U.magical*
273273
{that} (number) Non-magical number #2
274274
275275
Returns: ~
276-
{number} The magical number #1
277-
{number} The magical number #2
276+
(number) The magical number #1
277+
(number) The magical number #2
278278
and the fun part is the description can span
279279
280280
over mulitple lines and preserves empty lines
@@ -357,7 +357,7 @@ U.multi_line({opts}, {reserverd}) *U.multi_line*
357357
{reserverd} (table|nil) reserved for the future use
358358
359359
Returns: ~
360-
{boolean}
360+
(boolean)
361361
362362
363363
U.missing_desc({n}, {m}) *U.missing_desc*
@@ -371,7 +371,7 @@ U.missing_desc({n}, {m}) *U.missing_desc*
371371
372372
373373
Returns: ~
374-
{number}
374+
(number)
375375
376376
377377
"
@@ -466,7 +466,7 @@ U:create() *U:create*
466466
Creates a Human
467467
468468
Returns: ~
469-
{Human}
469+
(Human)
470470
471471
Usage: ~
472472
>
@@ -593,7 +593,7 @@ U.get_all() *U.get_all*
593593
Returns all the content of the buffer
594594
595595
Returns: ~
596-
{Lines}
596+
(Lines)
597597
598598
599599
U.LINES *U.LINES*
@@ -693,7 +693,7 @@ Config:get() *Config:get*
693693
Get the config
694694
695695
Returns: ~
696-
{number}
696+
(number)
697697
698698
699699
"

tests/with_settings.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ U:create() *U:create*
6565
Creates a PI
6666
6767
Returns: ~
68-
{number}
68+
(number)
6969
7070
Usage: ~
7171
>
@@ -123,7 +123,7 @@ U:create() *awesome:create*
123123
Creates a PI
124124
125125
Returns: ~
126-
{number}
126+
(number)
127127
128128
Usage: ~
129129
>

0 commit comments

Comments
 (0)