Fix typos + minor doc tweaks (#945)

Co-authored-by: Dirk Bäumer <dirkb@microsoft.com>

protocol/src/common/protocol.callHierarchy.ts

@@ -50,7 +50,7 @@ export interface CallHierarchyPrepareParams extends TextDocumentPositionParams,
 
 /**
  * A request to result a `CallHierarchyItem` in a document at a given position.
- * Can be used as an input to a incoming or outgoing call hierarchy.
+ * Can be used as an input to an incoming or outgoing call hierarchy.
  *
  * @since 3.16.0
  */

protocol/src/common/protocol.diagnostic.ts

@@ -111,7 +111,7 @@ export namespace DiagnosticServerCancellationData {
  *
  * @since 3.17.0
  */
-export type DocumentDiagnosticParams =  WorkDoneProgressParams & PartialResultParams & {
+export type DocumentDiagnosticParams = WorkDoneProgressParams & PartialResultParams & {
 	/**
 	 * The text document.
 	 */
@@ -231,14 +231,14 @@ export type RelatedUnchangedDocumentDiagnosticReport = UnchangedDocumentDiagnost
 	 * @since 3.17.0
 	 */
 	relatedDocuments?: {
-		[uri: DocumentUri ]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport;
+		[uri: DocumentUri]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport;
 	};
 };
 
 /**
  * The result of a document diagnostic pull request. A report can
  * either be a full report containing all diagnostics for the
- * requested document or a unchanged report indicating that nothing
+ * requested document or an unchanged report indicating that nothing
  * has changed in terms of diagnostics in comparison to the last
  * pull request.
  *

protocol/src/common/protocol.fileOperations.ts

@@ -15,32 +15,32 @@ import { ProtocolNotificationType, ProtocolRequestType } from './messages';
 export interface FileOperationOptions {
 
 	/**
-	* The server is interested in didCreateFiles notifications.
+	* The server is interested in receiving didCreateFiles notifications.
 	*/
 	didCreate?: FileOperationRegistrationOptions;
 
 	/**
-	* The server is interested in willCreateFiles requests.
+	* The server is interested in receiving willCreateFiles requests.
 	*/
 	willCreate?: FileOperationRegistrationOptions;
 
 	/**
-	* The server is interested in didRenameFiles notifications.
+	* The server is interested in receiving didRenameFiles notifications.
 	*/
 	didRename?: FileOperationRegistrationOptions;
 
 	/**
-	* The server is interested in willRenameFiles requests.
+	* The server is interested in receiving willRenameFiles requests.
 	*/
 	willRename?: FileOperationRegistrationOptions;
 
 	/**
-	* The server is interested in didDeleteFiles file notifications.
+	* The server is interested in receiving didDeleteFiles file notifications.
 	*/
 	didDelete?: FileOperationRegistrationOptions;
 
 	/**
-	* The server is interested in willDeleteFiles file requests.
+	* The server is interested in receiving willDeleteFiles file requests.
 	*/
 	willDelete?: FileOperationRegistrationOptions;
 }
@@ -94,7 +94,7 @@ export interface FileOperationPatternOptions {
 
 /**
  * A pattern to describe in which file operation requests or notifications
- * the server is interested in.
+ * the server is interested in receiving.
  *
  * @since 3.16.0
  */
@@ -126,14 +126,14 @@ interface FileOperationPattern {
 
 /**
  * A filter to describe in which file operation requests or notifications
- * the server is interested in.
+ * the server is interested in receiving.
  *
  * @since 3.16.0
  */
 export interface FileOperationFilter {
 
 	/**
-	 * A Uri like `file` or `untitled`.
+	 * A Uri scheme like `file` or `untitled`.
 	 */
 	scheme?: string;
 
@@ -164,7 +164,7 @@ export interface FileOperationClientCapabilities {
 	didCreate?: boolean;
 
 	/**
-	 * The client has support for willCreateFiles requests.
+	 * The client has support for sending willCreateFiles requests.
 	 */
 	willCreate?: boolean;
 
@@ -174,7 +174,7 @@ export interface FileOperationClientCapabilities {
 	didRename?: boolean;
 
 	/**
-	 * The client has support for willRenameFiles requests.
+	 * The client has support for sending willRenameFiles requests.
 	 */
 	willRename?: boolean;
 
@@ -184,13 +184,14 @@ export interface FileOperationClientCapabilities {
 	didDelete?: boolean;
 
 	/**
-	 * The client has support for willDeleteFiles requests.
+	 * The client has support for sending willDeleteFiles requests.
 	 */
 	willDelete?: boolean;
 }
 
 /**
- * The parameters sent in file create requests/notifications.
+ * The parameters sent in notifications/requests for user-initiated creation of
+ * files.
  *
  * @since 3.16.0
  */
@@ -216,7 +217,8 @@ export interface FileCreate {
 }
 
 /**
- * The parameters sent in file rename requests/notifications.
+ * The parameters sent in notifications/requests for user-initiated renames of
+ * files.
  *
  * @since 3.16.0
  */
@@ -248,7 +250,8 @@ export interface FileRename {
 }
 
 /**
- * The parameters sent in file delete requests/notifications.
+ * The parameters sent in notifications/requests for user-initiated deletes of
+ * files.
  *
  * @since 3.16.0
  */

protocol/src/common/protocol.foldingRange.ts

@@ -42,7 +42,7 @@ export interface FoldingRangeClientCapabilities {
 	 *
 	 * @since 3.17.0
 	 */
-	foldingRangeKind? : {
+	foldingRangeKind?: {
 		/**
 		 * The folding range kind values the client supports. When this
 		 * property exists the client also guarantees that it will
@@ -54,6 +54,7 @@ export interface FoldingRangeClientCapabilities {
 
 	/**
 	 * Specific options for the folding range.
+	 *
 	 * @since 3.17.0
 	 */
 	foldingRange?: {

protocol/src/common/protocol.inlayHint.ts

@@ -10,7 +10,7 @@ import { ProtocolRequestType, ProtocolRequestType0 } from './messages';
 import type { StaticRegistrationOptions, TextDocumentRegistrationOptions, WorkDoneProgressOptions, WorkDoneProgressParams } from './protocol';
 
 /**
- * Inlay hint client capabilities
+ * Inlay hint client capabilities.
  *
  * @since 3.17.0
  */
@@ -22,7 +22,7 @@ export type InlayHintClientCapabilities = {
 	dynamicRegistration?: boolean;
 
 	/**
-	 * Indicates which properties a client can resolve lazily on a inlay
+	 * Indicates which properties a client can resolve lazily on an inlay
 	 * hint.
 	 */
 	resolveSupport?: {
@@ -74,7 +74,7 @@ export type InlayHintOptions = WorkDoneProgressOptions & {
 export type InlayHintRegistrationOptions = InlayHintOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions;
 
 /**
- * A parameter literal used in inlay hints requests.
+ * A parameter literal used in inlay hint requests.
  *
  * @since 3.17.0
  */
@@ -104,7 +104,7 @@ export namespace InlayHintRequest {
 }
 
 /**
- * A request to resolve additional properties for a inlay hint.
+ * A request to resolve additional properties for an inlay hint.
  * The request's parameter is of type [InlayHint](#InlayHint), the response is
  * of type [InlayHint](#InlayHint) or a Thenable that resolves to such.
  *

protocol/src/common/protocol.notebook.ts

@@ -41,13 +41,13 @@ export type NotebookDocumentSyncClientCapabilities = {
 export namespace NotebookCellKind {
 
 	/**
-     * A markup-cell is formatted source that is used for display.
-     */
+	 * A markup-cell is formatted source that is used for display.
+	 */
 	export const Markup: 1 = 1;
 
 	/**
-     * A code-cell is source code.
-     */
+	 * A code-cell is source code.
+	 */
 	export const Code: 2 = 2;
 
 	export function is(value: any): value is NotebookCellKind {
@@ -298,7 +298,7 @@ export type VersionedNotebookDocumentIdentifier = {
  * Options specific to a notebook plus its cells
  * to be synced to the server.
  *
- * If a selector provide a notebook document
+ * If a selector provides a notebook document
  * filter but no cell selector all cells of a
  * matching notebook document will be synced.
  *
@@ -316,8 +316,8 @@ export type NotebookDocumentSyncOptions = {
 	notebookSelector: ({
 		/**
 		 * The notebook to be synced If a string
-	 	 * value is provided it matches against the
-	     * notebook type. '*' matches every notebook.
+		 * value is provided it matches against the
+		 * notebook type. '*' matches every notebook.
 		 */
 		notebook: string | NotebookDocumentFilter;
 
@@ -328,8 +328,8 @@ export type NotebookDocumentSyncOptions = {
 	} | {
 		/**
 		 * The notebook to be synced If a string
-	 	 * value is provided it matches against the
-	     * notebook type. '*' matches every notebook.
+		 * value is provided it matches against the
+		 * notebook type. '*' matches every notebook.
 		 */
 		notebook?: string | NotebookDocumentFilter;
 
@@ -359,7 +359,7 @@ export namespace NotebookDocumentSyncRegistrationType {
 }
 
 /**
- * The params sent in a open notebook document notification.
+ * The params sent in an open notebook document notification.
  *
  * @since 3.17.0
  */
@@ -470,8 +470,8 @@ export type NotebookDocumentChangeEvent = {
 		data?: NotebookCell[];
 
 		/**
-    	 * Changes to the text content of notebook cells.
-     	 */
+		 * Changes to the text content of notebook cells.
+		 */
 		textContent?: {
 			document: VersionedTextDocumentIdentifier;
 			changes: TextDocumentContentChangeEvent[];

protocol/src/common/protocol.showDocument.ts

@@ -8,13 +8,13 @@ import { Range, URI } from 'vscode-languageserver-types';
 import { ProtocolRequestType } from './messages';
 
 /**
- * Client capabilities for the show document request.
+ * Client capabilities for the showDocument request.
  *
  * @since 3.16.0
  */
 export interface ShowDocumentClientCapabilities {
 	/**
-	 * The client has support for the show document
+	 * The client has support for the showDocument
 	 * request.
 	 */
 	support: boolean;
@@ -42,7 +42,7 @@ export interface ShowDocumentParams {
 	 * An optional property to indicate whether the editor
 	 * showing the document should take focus or not.
 	 * Clients might ignore this property if an external
-	 * program in started.
+	 * program is started.
 	 */
 	takeFocus?: boolean;
 
@@ -56,7 +56,7 @@ export interface ShowDocumentParams {
 }
 
 /**
- * The result of an show document request.
+ * The result of a showDocument request.
  *
  * @since 3.16.0
  */