Skip to content

Commit 9ba4080

Browse files
committed
chore: remove 'audience' feature
1 parent e794792 commit 9ba4080

6 files changed

Lines changed: 6 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ registerAdapter("pyodide", pyodideAdapter);
3535
// later, when you have an error string and some code:
3636
const result = friendlyExplain({
3737
error: rawTracebackString,
38-
code: editorCode,
39-
audience: "beginner"
38+
code: editorCode
4039
});
4140

4241
// result.html is a ready-made snippet

docs/index.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,7 @@ <h1>Python Friendly Error Messages - Demo</h1>
123123
try {
124124
const result = friendlyExplain({
125125
error: example.trace,
126-
code: example.code,
127-
audience: 'beginner'
126+
code: example.code
128127
});
129128

130129
html += `

docs/local-demo.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,7 @@ <h1>Python Friendly Error Messages - Local Demo</h1>
123123
try {
124124
const result = friendlyExplain({
125125
error: example.trace,
126-
code: example.code,
127-
audience: 'beginner'
126+
code: example.code
128127
});
129128

130129
html += `

src/engine.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ const coerceTrace = (input: string | Error | Trace, code?: string): Trace => {
4141
return t;
4242
};
4343

44-
const pickVariant = (trace: Trace, code: string | undefined, audience: string) => {
44+
const pickVariant = (trace: Trace, code: string | undefined) => {
4545
const deck = state.copy;
4646
const kind = trace.type && deck?.errors[trace.type] ? trace.type : "Other";
4747
const entry = deck?.errors[kind];
@@ -122,7 +122,6 @@ const pickVariant = (trace: Trace, code: string | undefined, audience: string) =
122122

123123
export const friendlyExplain = (opts: ExplainOptions): ExplainResult => {
124124
if (!state.copy) throw new Error("Copydeck not loaded");
125-
const audience = opts.audience || "beginner";
126125
const code = opts.code;
127126

128127
const trace = coerceTrace(opts.error, code);
@@ -131,7 +130,7 @@ export const friendlyExplain = (opts: ExplainOptions): ExplainResult => {
131130
trace.codeLine = lines[trace.line - 1]?.trim();
132131
}
133132

134-
const chosen = pickVariant(trace, code, audience);
133+
const chosen = pickVariant(trace, code);
135134
if (!chosen) {
136135
return {
137136
trace,

src/types.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ export type Trace = {
2020
export type ExplainOptions = {
2121
error: string | Error | Trace;
2222
code?: string;
23-
audience?: "kid" | "beginner" | "intermediate";
2423
locale?: string;
2524
};
2625

tests/engine.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ describe("engine", () => {
6969
const raw = `Traceback (most recent call last):
7070
File "main.py", line 2, in <module>
7171
NameError: name 'kittens' is not defined`;
72-
const res = friendlyExplain({ error: raw, code, audience: "beginner" });
72+
const res = friendlyExplain({ error: raw, code });
7373
expect(res.trace.type).toBe("NameError");
7474
expect(res.title).toMatch(/name/i);
7575
expect(res.summary).toMatch(/kittens/);

0 commit comments

Comments
 (0)