提交 59bb06ea 编写于 作者: D Drew Diamantoukos 提交者: Benjamin Pasero

Cleaning up some typos in vscode.d.ts and vscode.proposed.d.ts (#50533)

上级 3e06a9de
......@@ -205,7 +205,7 @@ declare module 'vscode' {
/**
* Get a word-range at the given position. By default words are defined by
* common separators, like space, -, _, etc. In addition, per languge custom
* common separators, like space, -, _, etc. In addition, per language custom
* [word definitions](#LanguageConfiguration.wordPattern) can be defined. It
* is also possible to provide a custom regular expression.
*
......@@ -483,7 +483,7 @@ declare module 'vscode' {
active: Position;
/**
* Create a selection from two postions.
* Create a selection from two positions.
*
* @param anchor A position.
* @param active A position.
......@@ -1038,7 +1038,7 @@ declare module 'vscode' {
/**
* Render options applied to the current decoration. For performance reasons, keep the
* number of decoration specific options small, and use decoration types whereever possible.
* number of decoration specific options small, and use decoration types wherever possible.
*/
renderOptions?: DecorationInstanceRenderOptions;
}
......@@ -1119,7 +1119,7 @@ declare module 'vscode' {
/**
* Insert a [snippet](#SnippetString) and put the editor into snippet mode. "Snippet mode"
* means the editor adds placeholders and additionals cursors so that the user can complete
* means the editor adds placeholders and additional cursors so that the user can complete
* or accept the snippet.
*
* @param snippet The snippet to insert in this edit.
......@@ -1310,7 +1310,7 @@ declare module 'vscode' {
* [Uri.parse](#Uri.parse).
*
* @param skipEncoding Do not percentage-encode the result, defaults to `false`. Note that
* the `#` and `?` characters occuring in the path will always be encoded.
* the `#` and `?` characters occurring in the path will always be encoded.
* @returns A string representation of this Uri.
*/
toString(skipEncoding?: boolean): string;
......@@ -1605,7 +1605,7 @@ declare module 'vscode' {
*
* * Note 1: A dialog can select files, folders, or both. This is not true for Windows
* which enforces to open either files or folder, but *not both*.
* * Note 2: Explictly setting `canSelectFiles` and `canSelectFolders` to `false` is futile
* * Note 2: Explicitly setting `canSelectFiles` and `canSelectFolders` to `false` is futile
* and the editor then silently adjusts the options to select files.
*/
export interface OpenDialogOptions {
......@@ -1855,7 +1855,7 @@ declare module 'vscode' {
* to that type `T`. In addition, `null` and `undefined` can be returned - either directly or from a
* thenable.
*
* The snippets below are all valid implementions of the [`HoverProvider`](#HoverProvider):
* The snippets below are all valid implementations of the [`HoverProvider`](#HoverProvider):
*
* ```ts
* let a: HoverProvider = {
......@@ -2181,7 +2181,7 @@ declare module 'vscode' {
}
/**
* The implemenetation provider interface defines the contract between extensions and
* The implementation provider interface defines the contract between extensions and
* the go to implementation feature.
*/
export interface ImplementationProvider {
......@@ -2718,7 +2718,7 @@ declare module 'vscode' {
* Builder-function that appends a tabstop (`$1`, `$2` etc) to
* the [`value`](#SnippetString.value) of this snippet string.
*
* @param number The number of this tabstop, defaults to an auto-incremet
* @param number The number of this tabstop, defaults to an auto-increment
* value starting at 1.
* @return This snippet string.
*/
......@@ -2730,7 +2730,7 @@ declare module 'vscode' {
*
* @param value The value of this placeholder - either a string or a function
* with which a nested snippet can be created.
* @param number The number of this tabstop, defaults to an auto-incremet
* @param number The number of this tabstop, defaults to an auto-increment
* value starting at 1.
* @return This snippet string.
*/
......@@ -3001,7 +3001,7 @@ declare module 'vscode' {
/**
* A completion item represents a text snippet that is proposed to complete text that is being typed.
*
* It is suffient to create a completion item from just a [label](#CompletionItem.label). In that
* It is sufficient to create a completion item from just a [label](#CompletionItem.label). In that
* case the completion item will replace the [word](#TextDocument.getWordRangeAtPosition)
* until the cursor with the given label or [insertText](#CompletionItem.insertText). Otherwise the
* the given [edit](#CompletionItem.textEdit) is used.
......@@ -3187,7 +3187,7 @@ declare module 'vscode' {
* Providers can delay the computation of the [`detail`](#CompletionItem.detail)
* and [`documentation`](#CompletionItem.documentation) properties by implementing the
* [`resolveCompletionItem`](#CompletionItemProvider.resolveCompletionItem)-function. However, properties that
* are needed for the inital sorting and filtering, like `sortText`, `filterText`, `insertText`, and `range`, must
* are needed for the initial sorting and filtering, like `sortText`, `filterText`, `insertText`, and `range`, must
* not be changed during resolve.
*
* Providers are asked for completions either explicitly by a user gesture or -depending on the configuration-
......@@ -3267,7 +3267,7 @@ declare module 'vscode' {
/**
* Given a link fill in its [target](#DocumentLink.target). This method is called when an incomplete
* link is selected in the UI. Providers can implement this method and return incomple links
* link is selected in the UI. Providers can implement this method and return incomplete links
* (without target) from the [`provideDocumentLinks`](#DocumentLinkProvider.provideDocumentLinks) method which
* often helps to improve performance.
*
......@@ -3307,7 +3307,7 @@ declare module 'vscode' {
*
* @param red The red component.
* @param green The green component.
* @param blue The bluew component.
* @param blue The blue component.
* @param alpha The alpha component.
*/
constructor(red: number, green: number, blue: number, alpha: number);
......@@ -3319,7 +3319,7 @@ declare module 'vscode' {
export class ColorInformation {
/**
* The range in the document where this color appers.
* The range in the document where this color appears.
*/
range: Range;
......@@ -3387,7 +3387,7 @@ declare module 'vscode' {
*
* @param document The document in which the command was invoked.
* @param token A cancellation token.
* @return An array of [color informations](#ColorInformation) or a thenable that resolves to such. The lack of a result
* @return An array of [color information](#ColorInformation) or a thenable that resolves to such. The lack of a result
* can be signaled by returning `undefined`, `null`, or an empty array.
*/
provideDocumentColors(document: TextDocument, token: CancellationToken): ProviderResult<ColorInformation[]>;
......@@ -3506,7 +3506,7 @@ declare module 'vscode' {
*/
export interface IndentationRule {
/**
* If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
* If a line matches this pattern, then all the lines after it should be unindented once (until another rule matches).
*/
decreaseIndentPattern: RegExp;
/**
......@@ -3737,7 +3737,7 @@ declare module 'vscode' {
* The *effective* value (returned by [`get`](#WorkspaceConfiguration.get))
* is computed like this: `defaultValue` overwritten by `globalValue`,
* `globalValue` overwritten by `workspaceValue`. `workspaceValue` overwritten by `workspaceFolderValue`.
* Refer to [Settings Inheritence](https://code.visualstudio.com/docs/getstarted/settings)
* Refer to [Settings Inheritance](https://code.visualstudio.com/docs/getstarted/settings)
* for more information.
*
* *Note:* The configuration name must denote a leaf in the configuration tree
......@@ -3762,7 +3762,7 @@ declare module 'vscode' {
* has no observable effect in that workspace, but in others. Setting a workspace value
* in the presence of a more specific folder value has no observable effect for the resources
* under respective [folder](#workspace.workspaceFolders), but in others. Refer to
* [Settings Inheritence](https://code.visualstudio.com/docs/getstarted/settings) for more information.
* [Settings Inheritance](https://code.visualstudio.com/docs/getstarted/settings) for more information.
*
* *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
*
......@@ -4614,7 +4614,7 @@ declare module 'vscode' {
/**
* Defines how an argument should be quoted if it contains
* spaces or unsuppoerted characters.
* spaces or unsupported characters.
*/
export enum ShellQuoting {
......@@ -5222,7 +5222,7 @@ declare module 'vscode' {
*
* @param oldUri The existing file.
* @param newUri The new location.
* @param options Defines if existing files should be overwriten.
* @param options Defines if existing files should be overwritten.
* @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `oldUri` doesn't exist.
* @throws [`FileNotFound`](#FileSystemError.FileNotFound) when parent of `newUri` doesn't exist, e.g. no mkdirp-logic required.
* @throws [`FileExists`](#FileSystemError.FileExists) when `newUri` exists and when the `overwrite` option is not `true`.
......@@ -5297,7 +5297,7 @@ declare module 'vscode' {
/**
* Post a message to the webview content.
*
* Messages are only develivered if the webview is visible.
* Messages are only delivered if the webview is visible.
*
* @param message Body of the message.
*/
......@@ -5422,14 +5422,14 @@ declare module 'vscode' {
*/
interface WebviewPanelSerializer {
/**
* Restore a webview panel from its seriailzed `state`.
* Restore a webview panel from its serialized `state`.
*
* Called when a serialized webview first becomes visible.
*
* @param webviewPanel Webview panel to restore. The serializer should take ownership of this panel.
* @param state Persisted state. This state comesfrom the value set inside the webview by `acquireVsCodeApi().setState`.
* @param state Persisted state. This state comes from the value set inside the webview by `acquireVsCodeApi().setState`.
*
* @return Thanble indicating that the webview has been fully restored.
* @return Thenable indicating that the webview has been fully restored.
*/
deserializeWebviewPanel(webviewPanel: WebviewPanel, state: any): Thenable<void>;
}
......@@ -5981,7 +5981,7 @@ declare module 'vscode' {
*
* @param task A callback returning a promise. Progress increments can be reported with
* the provided [progress](#Progress)-object.
* @return The thenable the task did rseturn.
* @return The thenable the task did return.
*/
export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;
......@@ -6267,7 +6267,7 @@ declare module 'vscode' {
Window = 10,
/**
* Show progress as notifiation with an optional cancel button. Supports to show infinite and discrete progress.
* Show progress as notification with an optional cancel button. Supports to show infinite and discrete progress.
*/
Notification = 15
}
......@@ -6825,7 +6825,7 @@ declare module 'vscode' {
* 1. When the `DocumentFilter` is empty (`{}`) the result is `0`
* 2. When `scheme`, `language`, or `pattern` are defined but one doesn’t match, the result is `0`
* 3. Matching against `*` gives a score of `5`, matching via equality or via a glob-pattern gives a score of `10`
* 4. The result is the maximun value of each match
* 4. The result is the maximum value of each match
*
* Samples:
* ```js
......@@ -6864,7 +6864,7 @@ declare module 'vscode' {
* all extensions but *not yet* from the task framework.
*
* @param resource A resource
* @returns An arrary of [diagnostics](#Diagnostic) objects or an empty array.
* @returns An array of [diagnostics](#Diagnostic) objects or an empty array.
*/
export function getDiagnostics(resource: Uri): Diagnostic[];
......@@ -7631,7 +7631,7 @@ declare module 'vscode' {
/**
* Register a [debug configuration provider](#DebugConfigurationProvider) for a specifc debug type.
* Register a [debug configuration provider](#DebugConfigurationProvider) for a specific debug type.
* More than one provider can be registered for the same type.
*
* @param type The debug type for which the provider is registered.
......@@ -7724,7 +7724,7 @@ declare module 'vscode' {
/**
* Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
* and others. This API makes no assumption about what promise libary is being used which
* and others. This API makes no assumption about what promise library is being used which
* enables reusing existing code without migrating to a specific promise implementation. Still,
* we recommend the use of native promises which are available in this editor.
*/
......
......@@ -183,7 +183,7 @@ declare module 'vscode' {
export interface DebugConfigurationProvider {
/**
* This optional method is called just before a debug adapter is started to determine its excutable path and arguments.
* This optional method is called just before a debug adapter is started to determine its executable path and arguments.
* Registering more than one debugAdapterExecutable for a type results in an error.
* @param folder The workspace folder from which the configuration originates from or undefined for a folderless setup.
* @param token A cancellation token.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册