From 5427ae71cae5d4717c9c15acb9c23e4082c2d6a2 Mon Sep 17 00:00:00 2001
From: catloversg <152669316+catloversg@users.noreply.github.com>
Date: Wed, 14 Aug 2024 05:28:02 +0700
Subject: [PATCH] DOCUMENTATION: Fix wrong description of
 ns.singularity.applyToCompany (#1561)

---
 markdown/bitburner.singularity.applytocompany.md | 4 ++--
 src/ScriptEditor/NetscriptDefinitions.d.ts       | 8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md
index 4ac83f27d..85aeff1a0 100644
--- a/markdown/bitburner.singularity.applytocompany.md
+++ b/markdown/bitburner.singularity.applytocompany.md
@@ -23,7 +23,7 @@ applyToCompany(companyName: CompanyName | `${CompanyName}`, field: JobField | `$
 
 [JobName](./bitburner.jobname.md) \| null
 
-True if the player successfully get a job/promotion, and false otherwise.
+Job name if the player successfully get a job/promotion, and null otherwise.
 
 ## Remarks
 
@@ -31,5 +31,5 @@ RAM cost: 3 GB \* 16/4/1
 
 This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.
 
-This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and don’t get one, the function will return false.
+This function will return the job name if you successfully get a job/promotion, and null otherwise. Note that if you are trying to use this function to apply for a promotion and don’t get one, the function will return null.
 
diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
index 2fce6d443..b3764c122 100644
--- a/src/ScriptEditor/NetscriptDefinitions.d.ts
+++ b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -2046,13 +2046,13 @@ export interface Singularity {
    * apply for promotions by specifying the company and field you are already
    * employed at.
    *
-   * This function will return true if you successfully get a job/promotion,
-   * and false otherwise. Note that if you are trying to use this function to
-   * apply for a promotion and don’t get one, the function will return false.
+   * This function will return the job name if you successfully get a job/promotion,
+   * and null otherwise. Note that if you are trying to use this function to
+   * apply for a promotion and don’t get one, the function will return null.
    *
    * @param companyName - Name of company to apply to.
    * @param field - Field to which you want to apply.
-   * @returns True if the player successfully get a job/promotion, and false otherwise.
+   * @returns Job name if the player successfully get a job/promotion, and null otherwise.
    */
   applyToCompany(companyName: CompanyName | `${CompanyName}`, field: JobField | `${JobField}`): JobName | null;