chore: Add docstring.

google · Nov 21, 2024 · deac2d7 · deac2d7
1 parent 33ccbdc
commit deac2d7
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/block.ts b/core/block.ts
@@ -1108,6 +1108,11 @@ export class Block implements IASTNodeLocation {
     return null;
   }
 
+  /**
+   * Returns a generator that provides every field on the block.
+   *
+   * @yields A generator that can be used to iterate the fields on the block.
+   */
   *getFields(): Generator<Field> {
     for (const input of this.inputList) {
       for (const field of input.fieldRow) {