chore: better document comments

JounQin · JounQin · commit 0d30b7a76ae6 · 2022-08-10T08:41:58.000+08:00
diff --git a/src/index.ts b/src/index.ts
@@ -376,7 +376,7 @@ export function runAsWorker<
     /**
      * @see https://github.com/un-ts/synckit/issues/94
      *
-     * Creating the service can fail if the on-disk state is corrupt. In that case
+     * Starting the worker can fail, due to syntax error, for example. In that case
      * we just fail all incoming messages with whatever error message we got.
      * Otherwise incoming messages will hang forever waiting for a reply.
      */

Original file line number	Diff line number	Diff line change
`@@ -376,7 +376,7 @@ export function runAsWorker<`
`376`	`376`	`/**`
`377`	`377`	`* @see https://github.com/un-ts/synckit/issues/94`
`378`	`378`	`*`
`379`		`- * Creating the service can fail if the on-disk state is corrupt. In that case`
	`379`	`+ * Starting the worker can fail, due to syntax error, for example. In that case`
`380`	`380`	`* we just fail all incoming messages with whatever error message we got.`
`381`	`381`	`* Otherwise incoming messages will hang forever waiting for a reply.`
`382`	`382`	`*/`