From 5edcdaad814eaf842ebee02a91ab17beca121941 Mon Sep 17 00:00:00 2001 From: Duck McSouls Date: Thu, 6 Oct 2022 22:34:00 +1100 Subject: [PATCH 1/2] DOC: `ns.exec()`: typo fixes Some typographical fixes in the documentation of `ns.exec()`. Link to the function `ns.run()`. Currently, the line `* * @example` causes API Extractor to output an asterisk (i.e. `*`) between the two code examples. The function `ns.exec()` calls the function `runScriptFromScript()` from `src/NetscriptWorker.ts`, which uses the floor function to round down the number of threads. --- src/ScriptEditor/NetscriptDefinitions.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index c9230e181..3008a7712 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -5369,10 +5369,10 @@ export interface NS { * @remarks * RAM cost: 1.3 GB * - * Run a script as a separate process on a specified server. This is similar to the run function + * Run a script as a separate process on a specified server. This is similar to the function {@link NS.run | run} * except that it can be used to run a script on any server, instead of just the current server. * - * If the script was successfully started, then this functions returns the PID of that script. + * If the script was successfully started, then this function returns the PID of that script. * Otherwise, it returns 0. * * PID stands for Process ID. The PID is a unique identifier for each script. @@ -5392,7 +5392,7 @@ export interface NS { * //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: * exec("foo.script", "foodnstuff", 5, 1, "test"); * ``` - * * @example + * @example * ```ts * // NS2: * //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: @@ -5406,7 +5406,7 @@ export interface NS { * ``` * @param script - Filename of script to execute. * @param host - Hostname of the `target server` on which to execute the script. - * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. + * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. * @returns Returns the PID of a successfully started script, and 0 otherwise. */ From e3ace9f6d53f7c5d7952b78e126d16653ed321cc Mon Sep 17 00:00:00 2001 From: Duck McSouls Date: Thu, 6 Oct 2022 22:48:15 +1100 Subject: [PATCH 2/2] DOC: `ns.exec()`: break example comments into multiple lines The comment of each example is so long that, in the generated documentation for `ns.exec()` shown at https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.ns.exec.md you must use the horizontal scrollbar to read the whole comment. Even if you maximize the browser window, you must still use the horizontal scrollbar to read the whole comment. Tested on Brave, Chrome, Firefox, and Opera. Fix this by limiting each line of comment to at most 90 characters. --- src/ScriptEditor/NetscriptDefinitions.d.ts | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 3008a7712..4b4908890 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -5383,25 +5383,35 @@ export interface NS { * @example * ```ts * // NS1: - * //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: + * // The simplest way to use the exec command is to call it with just the script name + * // and the target server. The following example will try to run generic-hack.script + * // on the foodnstuff server. * exec("generic-hack.script", "foodnstuff"); * - * //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads: + * // The following example will try to run the script generic-hack.script on the + * // joesguns server with 10 threads. * exec("generic-hack.script", "joesguns", 10); * - * //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: + * // This last example will try to run the script foo.script on the foodnstuff server + * // with 5 threads. It will also pass the number 1 and the string “test” in as + * // arguments to the script. * exec("foo.script", "foodnstuff", 5, 1, "test"); * ``` * @example * ```ts * // NS2: - * //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: + * // The simplest way to use the exec command is to call it with just the script name + * // and the target server. The following example will try to run generic-hack.script + * // on the foodnstuff server. * ns.exec("generic-hack.script", "foodnstuff"); * - * //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads: + * // The following example will try to run the script generic-hack.script on the + * // joesguns server with 10 threads. * ns.exec("generic-hack.script", "joesguns", 10); * - * //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: + * // This last example will try to run the script foo.script on the foodnstuff server + * // with 5 threads. It will also pass the number 1 and the string “test” in as + * // arguments to the script. * ns.exec("foo.script", "foodnstuff", 5, 1, "test"); * ``` * @param script - Filename of script to execute.