Skip to content

Commit 7e6d23e

Browse files
committed
fix: move notes to the tags with desc as name
1 parent 8aa9ac0 commit 7e6d23e

File tree

2 files changed

+4
-10
lines changed

2 files changed

+4
-10
lines changed

src/fns/constants.js

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ const getTagsWithDescriptionAsName = () => [
5555
'file',
5656
'license',
5757
'remarks',
58+
'notes',
5859
'privateRemarks',
5960
'summary',
6061
'throws',
@@ -77,14 +78,7 @@ const getTagsThatRequireColumns = () => ['template'];
7778
*
7879
* @returns {string[]}
7980
*/
80-
const getTagsWithNameAsDescription = () => [
81-
'see',
82-
'borrows',
83-
'yields',
84-
'todo',
85-
'since',
86-
'notes',
87-
];
81+
const getTagsWithNameAsDescription = () => ['see', 'borrows', 'yields', 'todo', 'since'];
8882
/**
8983
* There are certain tags which description cannot be converted into sentences (upper case
9084
* and period at the end).

tests/e2e/fixtures/issue-21.fixture.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
* @param {foo} bar Baz.
1414
* @returns {number} Returns how the node is positioned relatively to the reference node according
1515
* to the bitmask. 0 if reference node and given node are the same.
16-
* @notes We should refactor how the multiline names are handled. And some extra text to make the
17-
* line longer.
16+
* @notes We should refactor how the multiline names are handled. And some extra text to make
17+
* the line longer.
1818
*/

0 commit comments

Comments
 (0)