Skip to content

Commit e794792

Browse files
committed
chore: remove 'verbosity' feature
1 parent 97a33a1 commit e794792

5 files changed

Lines changed: 3 additions & 14 deletions

File tree

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ registerAdapter("pyodide", pyodideAdapter);
3636
const result = friendlyExplain({
3737
error: rawTracebackString,
3838
code: editorCode,
39-
audience: "beginner",
40-
verbosity: "guided"
39+
audience: "beginner"
4140
});
4241

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

docs/index.html

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

131130
html += `

docs/local-demo.html

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

131130
html += `

src/engine.ts

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,6 @@ const pickVariant = (trace: Trace, code: string | undefined, audience: string) =
123123
export const friendlyExplain = (opts: ExplainOptions): ExplainResult => {
124124
if (!state.copy) throw new Error("Copydeck not loaded");
125125
const audience = opts.audience || "beginner";
126-
const verbosity = opts.verbosity || "standard";
127126
const code = opts.code;
128127

129128
const trace = coerceTrace(opts.error, code);
@@ -145,11 +144,5 @@ export const friendlyExplain = (opts: ExplainOptions): ExplainResult => {
145144
};
146145
}
147146

148-
// not convinced by this implementation, and may decide to drop the verbosity option entirely...
149-
if (verbosity === "brief") {
150-
chosen.why = undefined;
151-
chosen.steps = chosen.steps?.slice(0, 1);
152-
}
153-
154147
return { trace, ...chosen };
155148
};

src/types.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ export type ExplainOptions = {
2121
error: string | Error | Trace;
2222
code?: string;
2323
audience?: "kid" | "beginner" | "intermediate";
24-
verbosity?: "brief" | "standard" | "guided";
2524
locale?: string;
2625
};
2726

0 commit comments

Comments
 (0)