From 4ac49469b647395eed1f75d116f543d8b195824f Mon Sep 17 00:00:00 2001
From: Matt Lyons <matt_lyons@sil.org>
Date: Mon, 25 Sep 2023 16:46:34 -0500
Subject: [PATCH] Add a comment

---
 src/shared/models/project-data-provider.model.ts | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/shared/models/project-data-provider.model.ts b/src/shared/models/project-data-provider.model.ts
index 794f314387..be4148f671 100644
--- a/src/shared/models/project-data-provider.model.ts
+++ b/src/shared/models/project-data-provider.model.ts
@@ -2,7 +2,17 @@ import type { DataProviderDataType } from 'shared/models/data-provider.model';
 
 /** Indicates to a PDP what extension data is being referenced */
 export type ExtensionDataScope = {
+  /** Name of an extension as provided in its manifest */
   extensionName: string;
+  /** Name of a unique partition or segment of data within the extension
+   * Some examples include (but are not limited to):
+   *  - name of an important data structure that is maintained in a project
+   *  - name of a downloaded data set that is being cached
+   *  - name of a resource created by a user that should be maintained in a project
+   *
+   * This is the smallest level of granularity provided by a PDP for accessing extension data.
+   * There is no way to get or set just a portion of data identified by a single dataQualifier value.
+   * */
   dataQualifier: string;
 };