From 78cb4bf322618130275b0d8f74a129de38cd7447 Mon Sep 17 00:00:00 2001 From: Tib3rius <48113936+Tib3rius@users.noreply.github.com> Date: Sun, 15 Aug 2021 20:11:01 -0400 Subject: [PATCH] Updated API Documentation (markdown) --- API-Documentation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/API-Documentation.md b/API-Documentation.md index f4f7e40..b5ba393 100644 --- a/API-Documentation.md +++ b/API-Documentation.md @@ -34,7 +34,9 @@ The `execute` method can be used by a PortScan plugin to execute a command in a The optional `blocking` argument can be used to make the `execute` method return immediately, rather than waiting until the command has finished. This is useful if you want to process lines of output live. However, if you do this, you should always run the following command on the process object before returning: -```await process.wait()``` +```python +await process.wait() +``` The optional `outfile` and `errfile` arguments can be used to specify filenames to save stdout and stderr to respectively. Note that only the filename is required (e.g. "scan_output.txt", as the scandir path will be prepended.