From cb5b80a6d56eaf20bc4e93adbf6adcb68e44e496 Mon Sep 17 00:00:00 2001
From: catloversg <152669316+catloversg@users.noreply.github.com>
Date: Thu, 16 Oct 2025 01:58:11 +0700
Subject: [PATCH] DOCUMENTATION: Use alternative fix for newline issue in IPvGO
docs (#2350)
---
.editorconfig | 3 --
CONTRIBUTING.md | 6 ----
markdown/bitburner.go.getboardstate.md | 14 +++++++-
markdown/bitburner.go.getmovehistory.md | 14 +++++++-
markdown/bitburner.go.md | 28 +++++++++++++--
src/ScriptEditor/NetscriptDefinitions.d.ts | 40 ++++++++++++++--------
6 files changed, 78 insertions(+), 27 deletions(-)
diff --git a/.editorconfig b/.editorconfig
index 73744d151..713f4f7b0 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -6,8 +6,5 @@ indent_size = 2
trim_trailing_whitespace = true
insert_final_newline = true
-[src/ScriptEditor/NetscriptDefinitions.d.ts]
-trim_trailing_whitespace = false
-
[*.md]
trim_trailing_whitespace = false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 003f1652f..500163262 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -151,12 +151,6 @@ upstream/master
- Keep code-changes on a branch as small as possible. This makes it easier for code review. Each branch should be its own independent feature.
- Regularly rebase your branch against `dev` to make sure you have the latest updates pulled.
-### Special Exceptions
-
-- In `src/ScriptEditor/NetscriptDefinitions.d.ts`, there are two specially-formatted go boards with two trailing whitespaces.
- Make sure your editor does not automatically format those examples.
- You can look for changes to that part using `git diff` to make sure the whitespaces are still present.
-
## Running locally
Install
diff --git a/markdown/bitburner.go.getboardstate.md b/markdown/bitburner.go.getboardstate.md
index dbeeadb2b..13c770a5c 100644
--- a/markdown/bitburner.go.getboardstate.md
+++ b/markdown/bitburner.go.getboardstate.md
@@ -8,7 +8,19 @@ Retrieves a simplified version of the board state. "X" represents black pieces,
For example, a 5x5 board might look like this:
-\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
+\[
+
+"XX.O.",
+
+"X..OO",
+
+".XO..",
+
+"XXO.\#",
+
+".XO.\#",
+
+\]
Each string represents a vertical column on the board, and each character in the string represents a point.
diff --git a/markdown/bitburner.go.getmovehistory.md b/markdown/bitburner.go.getmovehistory.md
index 93b4c45cb..e9e378a43 100644
--- a/markdown/bitburner.go.getmovehistory.md
+++ b/markdown/bitburner.go.getmovehistory.md
@@ -8,7 +8,19 @@ Returns all the prior moves in the current game, as an array of simple board sta
For example, a single 5x5 prior move board might look like this:
-\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
+\[
+
+"XX.O.",
+
+"X..OO",
+
+".XO..",
+
+"XXO.\#",
+
+".XO.\#",
+
+\]
**Signature:**
diff --git a/markdown/bitburner.go.md b/markdown/bitburner.go.md
index 2c6b7dc7c..12eeea0a5 100644
--- a/markdown/bitburner.go.md
+++ b/markdown/bitburner.go.md
@@ -99,7 +99,19 @@ Retrieves a simplified version of the board state. "X" represents black pieces,
For example, a 5x5 board might look like this:
-\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
+\[
+
+"XX.O.",
+
+"X..OO",
+
+".XO..",
+
+"XXO.\#",
+
+".XO.\#",
+
+\]
Each string represents a vertical column on the board, and each character in the string represents a point.
@@ -142,7 +154,19 @@ Returns all the prior moves in the current game, as an array of simple board sta
For example, a single 5x5 prior move board might look like this:
-\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
+\[
+
+"XX.O.",
+
+"X..OO",
+
+".XO..",
+
+"XXO.\#",
+
+".XO.\#",
+
+\]
diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
index 42e4c4560..091a4a04b 100644
--- a/src/ScriptEditor/NetscriptDefinitions.d.ts
+++ b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -4935,13 +4935,19 @@ export interface Go {
*
* For example, a 5x5 board might look like this:
*
- [
- "XX.O.",
- "X..OO",
- ".XO..",
- "XXO.#",
- ".XO.#",
- ]
+ *[
+ *
+ * "XX.O.",
+ *
+ * "X..OO",
+ *
+ * ".XO..",
+ *
+ * "XXO.#",
+ *
+ * ".XO.#",
+ *
+ *]
*
* Each string represents a vertical column on the board, and each character in the string represents a point.
*
@@ -4961,13 +4967,19 @@ export interface Go {
*
* For example, a single 5x5 prior move board might look like this:
*
- [
- "XX.O.",
- "X..OO",
- ".XO..",
- "XXO.#",
- ".XO.#",
- ]
+ *[
+ *
+ * "XX.O.",
+ *
+ * "X..OO",
+ *
+ * ".XO..",
+ *
+ * "XXO.#",
+ *
+ * ".XO.#",
+ *
+ *]
*/
getMoveHistory(): string[][];