Skip to content

Commit 3a28f33

Browse files
committed
Fix docs typos
1 parent a627bd7 commit 3a28f33

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

twister/cli/templates/AGENTS.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import {
2828
} from "@plotday/twister";
2929
import { Plot } from "@plotday/twister/tools/plot";
3030

31-
export default class MyTwist extends twist<MyTwist> {
31+
export default class MyTwist extends Twist<MyTwist> {
3232
build(build: ToolBuilder) {
3333
return {
3434
plot: build(Plot),

twister/docs/ADVANCED.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import { SlackTool } from "@mycompany/plot-slack-tool";
3232
import { twist, type Priority, type ToolBuilder } from "@plotday/twister";
3333
import { Plot } from "@plotday/twister/tools/plot";
3434

35-
export default class DevOpsTwist extends twist<DevOpsTwist> {
35+
export default class DevOpsTwist extends Twist<DevOpsTwist> {
3636
build(build: ToolBuilder) {
3737
return {
3838
plot: build(Plot),
@@ -77,7 +77,7 @@ interface WorkflowData {
7777
metadata: Record<string, any>;
7878
}
7979

80-
class WorkflowTwist extends twist<WorkflowTwist> {
80+
class WorkflowTwist extends Twist<WorkflowTwist> {
8181
async transitionTo(workflowId: string, newState: WorkflowState) {
8282
const workflow = await this.get<WorkflowData>(`workflow:${workflowId}`);
8383
if (!workflow) throw new Error("Workflow not found");
@@ -248,7 +248,7 @@ interface LogContext {
248248
[key: string]: any;
249249
}
250250

251-
class MyTwist extends twist<MyTwist> {
251+
class MyTwist extends Twist<MyTwist> {
252252
private log(
253253
level: "info" | "warn" | "error",
254254
message: string,
@@ -289,7 +289,7 @@ class MyTwist extends twist<MyTwist> {
289289
Add debug flag for verbose logging:
290290

291291
```typescript
292-
class MyTwist extends twist<MyTwist> {
292+
class MyTwist extends Twist<MyTwist> {
293293
private get debugMode(): Promise<boolean> {
294294
return this.get<boolean>("debug_mode").then((v) => v ?? false);
295295
}
@@ -514,7 +514,7 @@ async upgrade() {
514514
Load data only when needed:
515515
516516
```typescript
517-
class MyTwist extends twist<MyTwist> {
517+
class MyTwist extends Twist<MyTwist> {
518518
private _config: Config | null = null;
519519

520520
private async getConfig(): Promise<Config> {

twister/docs/BUILDING_TOOLS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ import { twist, type ToolBuilder } from "@plotday/twister";
6565

6666
import { HelloTool } from "./tools/hello";
6767

68-
export default class MyTwist extends twist<MyTwist> {
68+
export default class MyTwist extends Twist<MyTwist> {
6969
build(build: ToolBuilder) {
7070
return {
7171
hello: build(HelloTool),
@@ -588,7 +588,7 @@ import { Plot } from "@plotday/twister/tools/plot";
588588

589589
import { GitHubTool } from "./github-tool";
590590

591-
class TestTwist extends twist<TestTwist> {
591+
class TestTwist extends Twist<TestTwist> {
592592
build(build: ToolBuilder) {
593593
return {
594594
plot: build(Plot),

twister/docs/RUNTIME.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Instance variables don't survive between invocations:
5757

5858
```typescript
5959
// ❌ WRONG - This doesn't work!
60-
class MyTwist extends twist<MyTwist> {
60+
class MyTwist extends Twist<MyTwist> {
6161
private syncToken: string = ""; // Lost after execution!
6262

6363
async activate() {
@@ -70,7 +70,7 @@ class MyTwist extends twist<MyTwist> {
7070
}
7171

7272
// ✅ CORRECT - Use Store
73-
class MyTwist extends twist<MyTwist> {
73+
class MyTwist extends Twist<MyTwist> {
7474
async activate() {
7575
await this.set("sync_token", "abc123"); // Persisted
7676
}

0 commit comments

Comments
 (0)