fix documentation for end

Almenon · Almenon · commit 0936099870d3 · 2020-05-03T09:15:39.000-07:00
diff --git a/index.ts b/index.ts
@@ -404,7 +404,8 @@ export class PythonShell extends EventEmitter{
     }
 
     /**
-     * Closes the stdin stream, which should cause the process to finish its work and close
+     * Closes the stdin stream. Unless python is listening for stdin in a loop 
+     * this should cause the process to finish its work and close.
      * @returns {PythonShell} The same instance for chaining calls
      */
     end(callback:(err:PythonShellError, exitCode:number,exitSignal:string)=>any) {

Original file line number	Diff line number	Diff line change
`@@ -404,7 +404,8 @@ export class PythonShell extends EventEmitter{`
`404`	`404`	`}`
`405`	`405`
`406`	`406`	`/**`
`407`		`- * Closes the stdin stream, which should cause the process to finish its work and close`
	`407`	`+ * Closes the stdin stream. Unless python is listening for stdin in a loop`
	`408`	`+ * this should cause the process to finish its work and close.`
`408`	`409`	`* @returns {PythonShell} The same instance for chaining calls`
`409`	`410`	`*/`
`410`	`411`	`end(callback:(err:PythonShellError, exitCode:number,exitSignal:string)=>any) {`