DOCUMENTATION: Use alternative fix for newline issue in IPvGO docs (#2350)

This commit is contained in:
catloversg
2025-10-16 01:58:11 +07:00
committed by GitHub
parent 30a572cfe6
commit cb5b80a6d5
6 changed files with 78 additions and 27 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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:
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
\[
"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.

View File

@@ -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:
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
**Signature:**

View File

@@ -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:
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
\[
"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:
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
</td></tr>

View File

@@ -4935,13 +4935,19 @@ export interface Go {
*
* For example, a 5x5 board might look like this:
*
[<br/>
"XX.O.",<br/>
"X..OO",<br/>
".XO..",<br/>
"XXO.#",<br/>
".XO.#",<br/>
]
*[
*
* "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:
*
[<br/>
"XX.O.",<br/>
"X..OO",<br/>
".XO..",<br/>
"XXO.#",<br/>
".XO.#",<br/>
]
*[
*
* "XX.O.",
*
* "X..OO",
*
* ".XO..",
*
* "XXO.#",
*
* ".XO.#",
*
*]
*/
getMoveHistory(): string[][];