From 23342f6dcc7c0bf636d51bfbd58b447b2f8875ad Mon Sep 17 00:00:00 2001 From: Olivier Gagnon Date: Tue, 23 Aug 2022 11:33:29 -0400 Subject: [PATCH] regen doc --- dist/bitburner.d.ts | 8 ++++---- markdown/bitburner.ns.exec.md | 2 +- markdown/bitburner.ns.run.md | 2 +- markdown/bitburner.ns.spawn.md | 2 ++ markdown/bitburner.singularity.md | 3 ++- 5 files changed, 10 insertions(+), 7 deletions(-) diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 08790f6b5..6999ec1c4 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -3433,8 +3433,7 @@ export declare interface NS { * PID stands for Process ID. The PID is a unique identifier for each script. * The PID will always be a positive integer. * - * Running this function with a numThreads argument of 0 will return 0 without running the script. - * However, running this function with a negative numThreads argument will cause a runtime error. + * Running this function with a numThreads argument of 0 or less will cause a runtime error. * * @example * ```ts @@ -3481,7 +3480,7 @@ export declare interface NS { * PID stands for Process ID. The PID is a unique identifier for each script. * The PID will always be a positive integer. * - * Running this function with 0 or a negative numThreads argument will cause a runtime error. + * Running this function with a numThreads argument of 0 or less will cause a runtime error. * * @example * ```ts @@ -3527,6 +3526,8 @@ export declare interface NS { * * Because this function immediately terminates the script, it does not have a return value. * + * Running this function with a numThreads argument of 0 or less will cause a runtime error. + * * @example * ```ts * // NS1: @@ -6757,7 +6758,6 @@ export declare interface TIX { /** * Short stocks. * @remarks - * @deprecated use sellShort * RAM cost: 2.5 GB * Attempts to purchase a short position of a stock using a Market Order. * diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md index a2f8cc17d..24837f0b9 100644 --- a/markdown/bitburner.ns.exec.md +++ b/markdown/bitburner.ns.exec.md @@ -37,7 +37,7 @@ If the script was successfully started, then this functions returns the PID of t PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. -Running this function with 0 or a negative numThreads argument will cause a runtime error. +Running this function with a numThreads argument of 0 or less will cause a runtime error. ## Example 1 diff --git a/markdown/bitburner.ns.run.md b/markdown/bitburner.ns.run.md index 78ccd26ef..842d46bca 100644 --- a/markdown/bitburner.ns.run.md +++ b/markdown/bitburner.ns.run.md @@ -36,7 +36,7 @@ If the script was successfully started, then this functions returns the PID of t PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. -Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. +Running this function with a numThreads argument of 0 or less will cause a runtime error. ## Example 1 diff --git a/markdown/bitburner.ns.spawn.md b/markdown/bitburner.ns.spawn.md index 4712c0047..5360c3478 100644 --- a/markdown/bitburner.ns.spawn.md +++ b/markdown/bitburner.ns.spawn.md @@ -32,6 +32,8 @@ Terminates the current script, and then after a delay of about 10 seconds it wil Because this function immediately terminates the script, it does not have a return value. +Running this function with a numThreads argument of 0 or less will cause a runtime error. + ## Example 1 diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index cf02bfa00..15d972455 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -9,7 +9,7 @@ Singularity API Signature: ```typescript -export interface Singularity +export interface Singularity ``` ## Remarks @@ -17,6 +17,7 @@ export interface Singularity This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels. ## Methods + | Method | Description | | --- | --- | | [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. |