From b0ea5fe602734a9d53003fb0882b6c6197dbd906 Mon Sep 17 00:00:00 2001 From: Aaron Dodson Date: Tue, 19 Aug 2025 12:59:27 -0700 Subject: [PATCH 1/3] chore: Replace @yields with @returns. --- core/block.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/block.ts b/core/block.ts index d15700a7e19..af44facda5d 100644 --- a/core/block.ts +++ b/core/block.ts @@ -1126,7 +1126,7 @@ export class Block { /** * Returns a generator that provides every field on the block. * - * @yields A generator that can be used to iterate the fields on the block. + * @returns A generator that can be used to iterate the fields on the block. */ *getFields(): Generator { for (const input of this.inputList) { From 8f505af6c3cc91bf923a05b17c31c64a7a6f7584 Mon Sep 17 00:00:00 2001 From: Aaron Dodson Date: Tue, 19 Aug 2025 13:01:10 -0700 Subject: [PATCH 2/3] fix: Update the ESLint config to not require @yields. --- eslint.config.mjs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/eslint.config.mjs b/eslint.config.mjs index f018e525d87..666b925118a 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -88,7 +88,8 @@ function buildTSOverride({files, tsconfig}) { '@typescript-eslint/no-explicit-any': ['off'], // We use this pattern extensively for block (e.g. controls_if) interfaces. '@typescript-eslint/no-empty-object-type': ['off'], - + // TSDoc doesn't support @yields, so don't require that we use it. + 'jsdoc/require-yields': ['off'], // params and returns docs are optional. 'jsdoc/require-param-description': ['off'], 'jsdoc/require-returns': ['off'], From 2f33bf18d5dc2dd4e9bed3e18ac551e2eacff41a Mon Sep 17 00:00:00 2001 From: Aaron Dodson Date: Tue, 19 Aug 2025 13:16:16 -0700 Subject: [PATCH 3/3] chore: Move docs onto getters. --- core/field.ts | 3 --- core/field_input.ts | 6 ++---- 2 files changed, 2 insertions(+), 7 deletions(-) diff --git a/core/field.ts b/core/field.ts index fdcb2d693b9..3d12880a93a 100644 --- a/core/field.ts +++ b/core/field.ts @@ -119,9 +119,6 @@ export abstract class Field return this.size; } - /** - * Sets the size of this field. - */ protected set size_(newValue: Size) { this.size = newValue; } diff --git a/core/field_input.ts b/core/field_input.ts index b685309183a..97ad0e9594d 100644 --- a/core/field_input.ts +++ b/core/field_input.ts @@ -102,11 +102,9 @@ export abstract class FieldInput extends Field< */ override SERIALIZABLE = true; - /** - * Sets the size of this field. Although this appears to be a no-op, it must - * exist since the getter is overridden below. - */ protected override set size_(newValue: Size) { + // Although this appears to be a no-op, it must exist since the getter is + // overridden below. super.size_ = newValue; }