Add JSDoc comment to Popover's focus() method #8312
Conversation
The public focus() method has documentation in the Popover component's README file, but it would be useful to have it in a JSDoc comment as well.
noisysocks
added
the
[Type] Code Quality
| * position. This is useful when a DOM change causes the anchor node to change | ||
| * position. | ||
| * | ||
| * @return {void} |
There was a problem hiding this comment.
There's a bit of a convention to not explicitly document the undefined return value. I seem to recall some discussion on it, but it should be formalized if we want to follow one way or the other.
There was a problem hiding this comment.
Can we add a lint rule one way or the other?
There was a problem hiding this comment.
Looking at this page, it might be possible by "requireReturn": false:
https://eslint.org/docs/rules/valid-jsdoc#options
false if and only if the function or method has a return statement or returns a value e.g. async function (this option value does apply to constructors)
There was a problem hiding this comment.
It looks like that's what we're doing:
Line 155 in 25f364b
I guess there's no way to require no @return {void} which is a shame.
Which is the lesser of two evils? Having to type @return {void} all the time, or allowing inconsistency? 😛
|
Thanks for adding this! |
The public focus() method has documentation in the Popover component's README file, but it would be useful to have it in a JSDoc comment as well.
Fixes #7219 (comment).