Skip to content

Commit d8c2afa

Browse files
committed
fix: remove @returns from throw-only methods to pass JSDoc linting
1 parent 8e814e0 commit d8c2afa

1 file changed

Lines changed: 1 addition & 5 deletions

File tree

src/testing.js

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ export class Failscape {
3434
* Always throws an error.
3535
*
3636
* @param {string} _arg The argument to escape.
37-
* @returns {string} Never returns.
3837
* @throws {Error} Always throws.
3938
*/
4039
escape(_arg) {
@@ -45,7 +44,6 @@ export class Failscape {
4544
* Always throws an error.
4645
*
4746
* @param {string[]} _args The arguments to escape.
48-
* @returns {string[]} Never returns.
4947
* @throws {Error} Always throws.
5048
*/
5149
escapeAll(_args) {
@@ -56,7 +54,6 @@ export class Failscape {
5654
* Always throws an error.
5755
*
5856
* @param {string} _arg The argument to quote and escape.
59-
* @returns {string} Never returns.
6057
* @throws {Error} Always throws.
6158
*/
6259
quote(_arg) {
@@ -67,7 +64,6 @@ export class Failscape {
6764
* Always throws an error.
6865
*
6966
* @param {string[]} _args The arguments to quote and escape.
70-
* @returns {string[]} Never returns.
7167
* @throws {Error} Always throws.
7268
*/
7369
quoteAll(_args) {
@@ -91,7 +87,7 @@ export class Stubscape {
9187
* Create a new {@link Stubscape} instance.
9288
*
9389
* @param {object} [options] The options for escaping.
94-
* @param {boolean|string} [options.shell] The shell to simulate.
90+
* @param {boolean | string} [options.shell] The shell to simulate.
9591
*/
9692
constructor(options = {}) {
9793
this.shell = options.shell;

0 commit comments

Comments
 (0)