Skip to content

Commit 4c7e85c

Browse files
committed
chore(docs/source/api): change "return" to overwrite "description" instead of adding to "return"
This is changed because "return" property was never used, but the "description" was (in pug files) but i am not familiar with pug to change that Also updates the second "replace" call because "\n" is mostly added to the end which makes it ineffective
1 parent a1eade6 commit 4c7e85c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/source/api.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@ function parse() {
162162
ctx.isFunction = true;
163163
break;
164164
case 'return':
165-
tag.return = tag.description ?
166-
md.parse(tag.description).replace(/^<p>/, '').replace(/<\/p>$/, '') :
165+
tag.description = tag.description ?
166+
md.parse(tag.description).replace(/^<p>/, '').replace(/<\/p>\n?$/, '') :
167167
'';
168168

169169
// dox does not add "void" / "undefined" to types, so in the documentation it would result in a empty "«»"

0 commit comments

Comments
 (0)