rename parameter to signature, #39441

microsoft · Jun 15, 2021 · d02cb73 · d02cb73
1 parent 298b6df
commit d02cb73
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/src/vs/editor/common/modes.ts b/src/vs/editor/common/modes.ts
@@ -495,7 +495,7 @@ export interface CompletionItemLabel {
  /**
  * The parameters without the return type. Render after `name`.
  */
- parameters?: string;
+ signature?: string;
 
  /**
  * The fully qualified name, like package name or file path. Rendered after `signature`.

diff --git a/src/vs/editor/contrib/suggest/suggestWidgetRenderer.ts b/src/vs/editor/contrib/suggest/suggestWidgetRenderer.ts
@@ -213,11 +213,11 @@ export class ItemRenderer implements IListRenderer<CompletionItem, ISuggestionTe
  data.root.classList.add('string-label');
  data.root.title = '';
  } else {
- data.parametersLabel.textContent = stripNewLines(completion.label.parameters || '');
+ data.parametersLabel.textContent = stripNewLines(completion.label.signature || '');
  data.qualifierLabel.textContent = stripNewLines(completion.label.qualifier || '');
  data.detailsLabel.textContent = stripNewLines(completion.label.type || '');
  data.root.classList.remove('string-label');
- data.root.title = `${element.textLabel}${completion.label.parameters ?? ''} ${completion.label.qualifier ?? ''} ${completion.label.type ?? ''}`;
+ data.root.title = `${element.textLabel}${completion.label.signature ?? ''} ${completion.label.qualifier ?? ''} ${completion.label.type ?? ''}`;
  }
 
  if (this._editor.getOption(EditorOption.suggest).showInlineDetails) {

diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts
@@ -5669,7 +5669,7 @@ declare namespace monaco.languages {
  /**
  * The parameters without the return type. Render after `name`.
  */
- parameters?: string;
+ signature?: string;
  /**
  * The fully qualified name, like package name or file path. Rendered after `signature`.
  */

diff --git a/src/vs/vscode.proposed.d.ts b/src/vs/vscode.proposed.d.ts
@@ -1389,8 +1389,7 @@ declare module 'vscode' {
  /**
  * The parameters without the return type. Render after `name`.
  */
- //todo@API rename to signature
- parameters?: string;
+ signature?: string;
 
  /**
  * The fully qualified name, like package name or file path. Rendered after `signature`.