Improve comments

angelapwen · henrymercer · web-flow · commit 8c50b52dbc1c · 2023-01-24T15:19:39.000-08:00
Co-authored-by: Henry Mercer &lt;henry.mercer@me.com&gt;
diff --git a/src/init-action.ts b/src/init-action.ts
@@ -82,11 +82,11 @@ interface InitWithConfigStatusReport extends InitStatusReport {
   trap_cache_download_duration_ms: number;
 }
 
-// Fields that we only send to the status report if the tools source was download.
+/** Fields of the init status report populated when the tools source is `download`. */
 interface InitToolsDownloadFields {
   /** Time taken to download the bundle, in milliseconds. */
   tools_download_duration_ms: number;
-  /** Whether the relevant tools dotcom feature flags have been misconfigured. Only sent if we attempt to download based off dotcom flags. */
+  /** Whether the relevant tools dotcom feature flags have been misconfigured. Only populated if we attempt to determine the default version based on the dotcom feature flags. */
   tools_feature_flags_valid: boolean;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -82,11 +82,11 @@ interface InitWithConfigStatusReport extends InitStatusReport {`
`82`	`82`	`trap_cache_download_duration_ms: number;`
`83`	`83`	`}`
`84`	`84`
`85`		`-// Fields that we only send to the status report if the tools source was download.`
	`85`	+/** Fields of the init status report populated when the tools source is `download`. */
`86`	`86`	`interface InitToolsDownloadFields {`
`87`	`87`	`/** Time taken to download the bundle, in milliseconds. */`
`88`	`88`	`tools_download_duration_ms: number;`
`89`		`- /** Whether the relevant tools dotcom feature flags have been misconfigured. Only sent if we attempt to download based off dotcom flags. */`
	`89`	`+ /** Whether the relevant tools dotcom feature flags have been misconfigured. Only populated if we attempt to determine the default version based on the dotcom feature flags. */`
`90`	`90`	`tools_feature_flags_valid: boolean;`
`91`	`91`	`}`
`92`	`92`