Add note about re-using options objects

Tyriar · Tyriar · commit 37ca38a4fbad · 2020-07-01T08:18:15.000-07:00
Fixes microsoft#101495
diff --git a/src/vs/workbench/services/hover/browser/hover.ts b/src/vs/workbench/services/hover/browser/hover.ts
@@ -16,7 +16,7 @@ export interface IHoverService {
 	readonly _serviceBrand: undefined;
 
 	/**
-	 * Shows a hover.
+	 * Shows a hover, provided a hover with the same options object is not already visible.
 	 * @param options A set of options defining the characteristics of the hover.
 	 * @param focus Whether to focus the hover (useful for keyboard accessibility).
 	 *

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ export interface IHoverService {`
`16`	`16`	`readonly _serviceBrand: undefined;`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Shows a hover.`
	`19`	`+ * Shows a hover, provided a hover with the same options object is not already visible.`
`20`	`20`	`* @param options A set of options defining the characteristics of the hover.`
`21`	`21`	`* @param focus Whether to focus the hover (useful for keyboard accessibility).`
`22`	`22`	`*`