Skip to content

Commit fc3442f

Browse files
docs for user guide
1 parent 1b145b8 commit fc3442f

File tree

36 files changed

+164
-121
lines changed

36 files changed

+164
-121
lines changed

docpages/basic-language-reference/BASIC_SOUND.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@ If you ever played games on a C64 or BBC Micro, you’ll remember how the same
5858

5959
Retro Rocket uses the classic **ADSR model** (Attack, Decay, Sustain, Release) found on many vintage synthesisers:
6060

61-
* **Attack** how quickly the sound rises from silence to full strength when a note begins.
62-
* **Decay** once the peak is reached, how fast the sound falls back down to a steady level.
63-
* **Sustain** the level held as long as the note continues.
64-
* **Release** how long the note takes to fade back to silence after it ends.
61+
* **Attack** - how quickly the sound rises from silence to full strength when a note begins.
62+
* **Decay** - once the peak is reached, how fast the sound falls back down to a steady level.
63+
* **Sustain** - the level held as long as the note continues.
64+
* **Release** - how long the note takes to fade back to silence after it ends.
6565

6666
## Flow of audio
6767

docpages/basic-language-reference/functions/integer/GETPROCCOUNT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ PRINT "Background job ended"
4040

4141
* The returned value is an **integer** ≥ 1 (the current program itself counts as a process).
4242
* Values change dynamically as processes are created or end.
43-
* Designed for diagnostic or monitoring use; it does not reveal details of which processes are running only the **total count**.
43+
* Designed for diagnostic or monitoring use; it does not reveal details of which processes are running - only the **total count**.
4444
* Use together with \ref GETPROCNAME\$ "GETPROCNAME\$" or \ref GETPROCID "GETPROCID" to identify individual processes.
4545

4646
---

docpages/basic-language-reference/functions/integer/LEN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ ENDIF
4545
### Notes
4646

4747
* Returns an integer value ≥ 0.
48-
* Length is measured in characters, not bytes since Retro Rocket BASIC strings are ASCII, the two are identical.
48+
* Length is measured in characters, not bytes - since Retro Rocket BASIC strings are ASCII, the two are identical.
4949
* Useful together with \ref LEFT "LEFT$", \ref RIGHT "RIGHT$", and \ref MID "MID$" for string slicing.
5050

5151
---

docpages/basic-language-reference/functions/integer/OCTVAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ PRINT o$; " = "; OCTVAL(o$)
4747
* **Important distinction:**
4848

4949
* In BASIC source code, you can write octal literals with a `&O` prefix (e.g. `&O755`).
50-
* In strings passed to `OCTVAL`, only the raw digits are valid no prefix.
50+
* In strings passed to `OCTVAL`, only the raw digits are valid - no prefix.
5151

5252
---
5353

docpages/basic-language-reference/functions/integer/RND.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ NEXT
4444
* The result is an **integer** within the inclusive range `[min, max]`.
4545
* If `min > max`, behaviour is undefined.
4646
* Suitable for general randomness in games, simulations, and sampling.
47-
* **Not cryptographically secure** although the kernel provides an unpredictable seed, the Mersenne Twister itself is deterministic and predictable if state is known.
47+
* **Not cryptographically secure** - although the kernel provides an unpredictable seed, the Mersenne Twister itself is deterministic and predictable if state is known.
4848
* **Retro Rocket BASIC difference:** BBC BASIC used a 33-bit LFSR (linear feedback shift register). Retro Rocket uses a modern PRNG (Mersenne Twister).
4949

5050
---

docpages/basic-language-reference/functions/integer/VAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Produces `0`.
4343

4444
* Returns a 64-bit signed integer.
4545
* If the string is empty or contains invalid characters, the return value is `0`.
46-
* Only integer values are supported fractional values are truncated or treated as invalid.
46+
* Only integer values are supported - fractional values are truncated or treated as invalid.
4747
* For parsing hexadecimal or octal strings, see \ref HEXVAL "HEXVAL" and \ref OCTVAL "OCTVAL".
4848

4949
---

docpages/basic-language-reference/functions/real/FMOD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Produces `5`.
3535

3636
### Notes
3737

38-
* `y` must not be `0` this causes an error.
38+
* `y` must not be `0` - this causes an error.
3939
* The result has the same sign as the dividend (`x`).
4040
* Differs from integer modulus (`%`) because it works with reals and preserves fractional parts.
4141
* Useful for periodic functions, angle wrapping, and floating-point arithmetic.

docpages/basic-language-reference/functions/string/GETNAME.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ NEXT
3434
* If the index is outside the valid range, an error is raised.
3535
* The path may be absolute (starting with `/`) or relative to the current working directory (\ref CSD "CSD\$").
3636
* The order of entries is determined by the filesystem and may not be sorted alphabetically.
37-
* Only the name is returned to distinguish files from directories, use \ref FILETYPE "FILETYPE\$".
37+
* Only the name is returned - to distinguish files from directories, use \ref FILETYPE "FILETYPE\$".
3838

3939
---
4040

docpages/basic-language-reference/functions/string/GETPROCSTATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The parameter is an index between `0` and `GETPROCCOUNT - 1`.
1717
| `suspended` | Process is waiting on another process to end before continuing. |
1818
| `waiting` | Process is blocked, waiting on I/O (e.g. disk, console, network). |
1919
| `ended` | Process no longer exists. |
20-
| `unknown` | Error state the status of this process cannot be determined. |
20+
| `unknown` | Error state - the status of this process cannot be determined. |
2121

2222
---
2323

docpages/basic-language-reference/functions/string/HIGHLIGHT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ Given a string containing BASIC source, returns a copy with ANSI SGR escape sequ
88

99
**Notes**
1010

11-
* **Strings** text between double quotes (`"..."`) is highlighted in **light yellow** from the opening quote to the closing quote. If a closing quote is missing, highlighting continues to the end of the input and is then reset.
11+
* **Strings** - text between double quotes (`"..."`) is highlighted in **light yellow** from the opening quote to the closing quote. If a closing quote is missing, highlighting continues to the end of the input and is then reset.
1212
* **Comments**
1313

1414
* A single quote (') begins a comment that is highlighted in **dark green** until the end of the input.
1515
* The keyword `REM` (when not inside a string) causes the **entire line** to be treated as a comment and highlighted in **dark green**.
16-
* **Keywords / tokens** recognised BASIC keywords are highlighted in **light blue** when they are not part of a longer identifier. Boundary detection prevents colouring inside names like `FORTH`. Exceptions: `PROC`, `FN`, and `=` may be adjacent to letters/digits/underscores and will still be highlighted.
16+
* **Keywords / tokens** - recognised BASIC keywords are highlighted in **light blue** when they are not part of a longer identifier. Boundary detection prevents colouring inside names like `FORTH`. Exceptions: `PROC`, `FN`, and `=` may be adjacent to letters/digits/underscores and will still be highlighted.
1717
* **Built-in functions**
1818

1919
* Integer-returning built-ins are **light green**.
2020
* String-returning built-ins are **light magenta**.
2121
* Real/float-returning built-ins are **light cyan**.
22-
* **Numeric literals** digits (and a leading unary `+`/`-`) are highlighted in **orange**.
23-
* **Operators & punctuation** `() + - * / = < > , ;` are highlighted in **dark red**.
24-
* **Default text** rendered in **white**. Colours are reset back to white after each coloured span, and a final reset is appended at the end of the result to prevent “colour leakage” in the caller’s terminal.
22+
* **Numeric literals** - digits (and a leading unary `+`/`-`) are highlighted in **orange**.
23+
* **Operators & punctuation** - `() + - * / = < > , ;` are highlighted in **dark red**.
24+
* **Default text** - rendered in **white**. Colours are reset back to white after each coloured span, and a final reset is appended at the end of the result to prevent “colour leakage” in the caller’s terminal.
2525

2626
**Errors**
2727

0 commit comments

Comments
 (0)