Add comment to AuthenticationProvider API

microsoft · Jan 27, 2020 · 8d36d09 · 8d36d09
1 parent 40173ec
commit 8d36d09
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
@@ -26,6 +26,11 @@ declare module 'vscode' {
  }
 
  export interface AuthenticationProvider {
+ /**
+ * Used as an identifier for extensions trying to work with a particular
+ * provider: 'Microsoft', 'GitHub', etc. id must be unique, registering
+ * another provider with the same id will fail.
+ */
  readonly id: string;
  readonly displayName: string;
  readonly onDidChangeSessions: Event<void>;