1 files changed, 7 insertions, 0 deletions
diff --git a/src/fields/Doc.ts b/src/fields/Doc.ts
index eb52cff88..4ed7ccb61 100644
--- a/src/fields/Doc.ts
+++ b/src/fields/Doc.ts
@@ -510,6 +510,13 @@ export namespace Doc {
     export function IsDelegateField(doc: Doc, fieldKey: string) {
         return doc && Get(doc, fieldKey, true) !== undefined;
     }
+    //
+    // this will write the value to the key on either the data doc or the embedding doc.  The choice
+    // of where to write it is based on:
+    // 1) if the embedding Doc already has this field defined on it, then it will be written to the embedding
+    // 2) if the data doc has the field, then it's written there.
+    // 3) if neither already has the field, then 'defaultProto' determines whether to write it to the data doc (or the embedding)
+    //
     export async function SetInPlace(doc: Doc, key: string, value: Field | undefined, defaultProto: boolean) {
         if (key.startsWith('_')) key = key.substring(1);
         const hasProto = Doc.GetProto(doc) !== doc ? Doc.GetProto(doc) : undefined;