From ddcb2adf71469dfd03bcb0d615779e6b3a10530f Mon Sep 17 00:00:00 2001
From: Damien Elmes <gpg@ankiweb.net>
Date: Mon, 29 Mar 2021 18:13:45 +1000
Subject: [PATCH] add docstring to forEditorField

---
 ts/editor/index.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/ts/editor/index.ts b/ts/editor/index.ts
index 4cd262704..acb18994f 100644
--- a/ts/editor/index.ts
+++ b/ts/editor/index.ts
@@ -92,6 +92,10 @@ export function getEditorField(n: number): EditorField | null {
     return (fields[n] as EditorField) ?? null;
 }
 
+/// forEachEditorFieldAndProvidedValue:
+/// Values should be a list with the same length as the
+/// number of fields. Func will be called with each field and
+/// value in turn.
 export function forEditorField<T>(
     values: T[],
     func: (field: EditorField, value: T) => void