Skip to content

Commit 30a9ddf

Browse files
authored
API reference documentation fixes (#407)
1 parent cf83edc commit 30a9ddf

File tree

12 files changed

+27
-27
lines changed

12 files changed

+27
-27
lines changed

docs/api-reference/animation/members/spring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ destruction tasks for this object.
4646
<h3 markdown>
4747
goal
4848
<span class="fusiondoc-api-type">
49-
: <a href="../../../state/types/used">UsedAs</a>&lt;T&gt;
49+
: <a href="../../../state/types/usedas">UsedAs</a>&lt;T&gt;
5050
</span>
5151
</h3>
5252

docs/api-reference/animation/types/spring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export type Spring<T> = StateObject<T> & {
1818
}
1919
```
2020

21-
A specialised [state object](../stateobject) for following a goal state smoothly
21+
A specialised [state object](../../../state/types/stateobject) for following a goal state smoothly
2222
over time, using physics to shape the motion.
2323

2424
The methods on this type allow for direct control over the position and velocity

docs/api-reference/animation/types/tween.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type Tween<T> = StateObject<T> & {
1515
}
1616
```
1717

18-
A specialised [state object](../stateobject) for following a goal state smoothly
18+
A specialised [state object](../../../state/types/stateobject) for following a goal state smoothly
1919
over time, using a `TweenInfo` to shape the motion.
2020

2121
This type isn't generally useful outside of Fusion itself.

docs/api-reference/general/errors.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Error in callback: attempt to perform arithmetic (add) on number and string
3838
[`ForKeys`](../../state/members/forkeys),
3939
[`ForValues`](../../state/members/forvalues),
4040
[`ForPairs`](../../state/members/forpairs),
41-
[`Contextual`](../../memory/members/contextual)
41+
[`Contextual`](../../general/members/contextual)
4242

4343
Fusion ran a function you specified, but the function threw an error that Fusion
4444
couldn't handle.
@@ -177,7 +177,7 @@ proceed.
177177
```
178178

179179
**Thrown by:**
180-
[`doCleanup`](../../memory/members/doCleanup)
180+
[`doCleanup`](../../memory/members/docleanup)
181181

182182
You called `doCleanup()` on a function or object which carried some code. When
183183
that code was run, it attempted to call `doCleanup()` on the same thing you
@@ -395,7 +395,7 @@ The damping ratio for a spring must be >= 0. (damping was -1.00)
395395
```
396396

397397
**Thrown by:**
398-
[`Spring`](../../roblox/members/spring)
398+
[`Spring`](../../animation/members/spring)
399399

400400
You provided a damping ratio that the spring doesn't support, for example `NaN`,
401401
or a negative damping implying negative friction.
@@ -412,7 +412,7 @@ The speed of a spring must be >= 0. (speed was NaN)
412412
```
413413

414414
**Thrown by:**
415-
[`Spring`](../../roblox/members/spring)
415+
[`Spring`](../../animation/members/spring)
416416

417417
You provided a speed multiplier that the spring doesn't support, for example
418418
`NaN` or a negative speed implying the spring moves backwards through time.
@@ -451,7 +451,7 @@ The damping ratio for a spring must be a number. (got a string)
451451
```
452452

453453
**Thrown by:**
454-
[`Spring`](../../roblox/members/spring)
454+
[`Spring`](../../animation/members/spring)
455455

456456
You provided a damping ratio that the spring couldn't understand. Damping ratio
457457
has to be a number.
@@ -468,7 +468,7 @@ The speed of a spring must be a number. (got a string)
468468
```
469469

470470
**Thrown by:**
471-
[`Spring`](../../roblox/members/spring)
471+
[`Spring`](../../animation/members/spring)
472472

473473
You provided a speed multiplier that the spring couldn't understand. Speed has
474474
to be a number.
@@ -485,7 +485,7 @@ The tween info of a tween must be a TweenInfo. (got a table)
485485
```
486486

487487
**Thrown by:**
488-
[`Tween`](../../roblox/members/tween)
488+
[`Tween`](../../animation/members/tween)
489489

490490
You provided an easing curve that the tween couldn't understand. The easing
491491
curve has to be specified using Roblox's `TweenInfo` data type.
@@ -521,7 +521,7 @@ called on this scope. Ensure you are not reusing scopes after cleanup.
521521
```
522522

523523
**Thrown by:**
524-
scopes after being passed to [`doCleanup`](../../memory/members/doCleanup)
524+
scopes after being passed to [`doCleanup`](../../memory/members/docleanup)
525525

526526
If you attempt to read from, or write to, a scope that's been destroyed, this
527527
message is shown. After a scope has been cleaned up, your code should forget the
@@ -552,7 +552,7 @@ belong to. See discussion #292 on GitHub for advice.
552552
[`Out`](../../roblox/members/out),
553553
[`Ref`](../../roblox/members/ref),
554554
[`Computed`](../../state/members/computed),
555-
[`Observer`](../../state/members/observer)
555+
[`Observer`](../../graph/members/observer)
556556

557557
**Related discussions:**
558558
[`#292`](https://github.com/dphfox/Fusion/discussions/292)
@@ -614,7 +614,7 @@ discussion #292 on GitHub for advice.
614614
[`Hydrate`](../../roblox/members/hydrate),
615615
[`Value`](../../state/members/value),
616616
[`Computed`](../../state/members/computed),
617-
[`Observer`](../../state/members/observer),
617+
[`Observer`](../../graph/members/observer),
618618
[`ForKeys`](../../state/members/forkeys),
619619
[`ForValues`](../../state/members/forvalues),
620620
[`ForPairs`](../../state/members/forpairs),
@@ -862,7 +862,7 @@ is use()-ing. See discussion #292 on GitHub for advice.
862862
[`Out`](../../roblox/members/out),
863863
[`Ref`](../../roblox/members/ref),
864864
[`Computed`](../../state/members/computed),
865-
[`Observer`](../../state/members/observer)
865+
[`Observer`](../../graph/members/observer)
866866

867867
**Related discussions:**
868868
[`#292`](https://github.com/dphfox/Fusion/discussions/292)

docs/api-reference/graph/members/observer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<span class="fusiondoc-api-icon" markdown>:octicons-workflow-24:</span>
99
<span class="fusiondoc-api-name">Observer</span>
1010
<span class="fusiondoc-api-type">
11-
-> <a href="../../../state/types/Observer">Observer</a>
11+
-> <a href="../../types/Observer">Observer</a>
1212
</span>
1313
</h1>
1414

@@ -59,7 +59,7 @@ The target that the observer should watch for changes.
5959
<h2 markdown>
6060
Returns
6161
<span class="fusiondoc-api-type">
62-
-> <a href="../../../state/types/observer">Observer</a>
62+
-> <a href="../../types/observer">Observer</a>
6363
</span>
6464
</h2>
6565

docs/api-reference/graph/types/observer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export type Observer = GraphObject & {
1818
}
1919
```
2020

21-
A [graph object](../graph object) that runs user code when it's updated by the
21+
A [graph object](../graphobject) that runs user code when it's updated by the
2222
reactive graph.
2323

2424
!!! note "Non-standard type syntax"

docs/api-reference/memory/members/derivescope.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Returns a blank [scope](../../types/scope) with the same methods as an existing
2323
scope, plus some optional additional methods which are merged in to only the
2424
new scope.
2525

26-
Unlike [innerScope](../derivescope), the returned scope has a completely
26+
Unlike [innerScope](../innerscope), the returned scope has a completely
2727
independent lifecycle from the original scope.
2828

2929
!!! note "Pseudo type"

docs/api-reference/state/members/computed.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ destruction tasks for this object.
4444
<h3 markdown>
4545
processor
4646
<span class="fusiondoc-api-type">
47-
: (<a href="../../../memory/types/use">Use</a>,
47+
: (<a href="../../types/use">Use</a>,
4848
<a href="../../../memory/types/scope">Scope</a>&lt;S&gt;) -> T
4949
</span>
5050
</h3>
5151

5252
Computes the value that will be used by the computed. The processor is given a
53-
[use function](../../../memory/types/use) for including other objects in the
53+
[use function](../../types/use) for including other objects in the
5454
computation, and a [scope](../../../memory/types/scope) for queueing destruction
5555
tasks to run on re-computation. The given scope has the same methods as the
5656
scope used to create the computed.

docs/api-reference/state/members/forkeys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If it is a state object, this object will respond to changes in that state.
5757
<h3 markdown>
5858
processor
5959
<span class="fusiondoc-api-type">
60-
: (<a href="../../../memory/types/use">Use</a>,
60+
: (<a href="../../types/use">Use</a>,
6161
<a href="../../../memory/types/scope">Scope</a>&lt;S&gt;,
6262
key: KI) -> KO
6363
</span>
@@ -66,7 +66,7 @@ If it is a state object, this object will respond to changes in that state.
6666
Accepts a `KI` key from the input table, and returns the `KO` key that should
6767
appear in the output table.
6868

69-
The processor is given a [use function](../../../memory/types/use) for including
69+
The processor is given a [use function](../../types/use) for including
7070
other objects in the computation, and a [scope](../../../memory/types/scope) for
7171
queueing destruction tasks to run on re-computation. The given scope has the
7272
same methods as the scope used to create the whole object.

docs/api-reference/state/members/forpairs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If it is a state object, this object will respond to changes in that state.
5757
<h3 markdown>
5858
processor
5959
<span class="fusiondoc-api-type">
60-
: (<a href="../../../memory/types/use">Use</a>,
60+
: (<a href="../../types/use">Use</a>,
6161
<a href="../../../memory/types/scope">Scope</a>&lt;S&gt;,
6262
key: KI, value: VI) -> (KO, VO)
6363
</span>
@@ -66,7 +66,7 @@ If it is a state object, this object will respond to changes in that state.
6666
Accepts a `KI` key and `VI` value pair from the input table, and returns the
6767
`KO` key and `VO` value pair that should appear in the output table.
6868

69-
The processor is given a [use function](../../../memory/types/use) for including
69+
The processor is given a [use function](../../types/use) for including
7070
other objects in the computation, and a [scope](../../../memory/types/scope) for
7171
queueing destruction tasks to run on re-computation. The given scope has the
7272
same methods as the scope used to create the whole object.

0 commit comments

Comments
 (0)