fix: fix the doc for onShowDocument

aminya · aminya · commit 03b9b202e9ac · 2021-03-16T20:47:09.000-05:00
diff --git a/lib/adapters/show-document-adapter.ts b/lib/adapters/show-document-adapter.ts
@@ -23,10 +23,12 @@ export function attach(connection: LanguageClientConnection): void {
 }
 
 /**
- * Public: Show a notification message with buttons using the Atom notifications API.
+ * Public: show documents inside Atom text editor or in external programs
  *
  * @param params The {ShowDocumentParams} received from the language server
  *   indicating the document to be displayed as well as other metadata.
+ * @returns {Promise<ShowDocumentResult>} with a `success: boolean` property specifying if the operation was sucessful
+ * {@inheritDoc ShowDocumentParams}
  */
 export async function onShowDocument(params: ShowDocumentParams): Promise<ShowDocumentResult> {
   if (!params.external) {

Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,12 @@ export function attach(connection: LanguageClientConnection): void {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`/**`
`26`		`- * Public: Show a notification message with buttons using the Atom notifications API.`
	`26`	`+ * Public: show documents inside Atom text editor or in external programs`
`27`	`27`	`*`
`28`	`28`	`* @param params The {ShowDocumentParams} received from the language server`
`29`	`29`	`* indicating the document to be displayed as well as other metadata.`
	`30`	+ * @returns {Promise<ShowDocumentResult>} with a `success: boolean` property specifying if the operation was sucessful
	`31`	`+ * {@inheritDoc ShowDocumentParams}`
`30`	`32`	`*/`
`31`	`33`	`export async function onShowDocument(params: ShowDocumentParams): Promise<ShowDocumentResult> {`
`32`	`34`	`if (!params.external) {`