From f923ac98e92f4b6405450c542727ba6ea2f7564c Mon Sep 17 00:00:00 2001
From: Benjamin Pasero <benjpas@microsoft.com>
Date: Wed, 4 Nov 2020 15:40:13 +0100
Subject: [PATCH] storage - document enum better

---
 src/vs/platform/storage/common/storage.ts | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/vs/platform/storage/common/storage.ts b/src/vs/platform/storage/common/storage.ts
index 5b515af5759..ef84c630809 100644
--- a/src/vs/platform/storage/common/storage.ts
+++ b/src/vs/platform/storage/common/storage.ts
@@ -15,8 +15,16 @@ const TARGET_KEY = '__$__targetStorageMarker';
 export const IStorageService = createDecorator<IStorageService>('storageService');
 
 export enum WillSaveStateReason {
-	NONE = 0,
-	SHUTDOWN = 1
+
+	/**
+	 * No specific reason to save state.
+	 */
+	NONE,
+
+	/**
+	 * A hint that the workbench is about to shutdown.
+	 */
+	SHUTDOWN
 }
 
 export interface IWillSaveStateEvent {
-- 
GitLab