Merge branch 'main' of github.com:RaspberryPiFoundation/python-friendly-errors

Author: grega

README.md

@@ -1,19 +1,20 @@
-# Python friendly error messages
+# Python Friendly Error Messages
 
 - [ ] Ensure all strings in `src/` are localised
 - [ ] Consider renaming `explain()` to something like `friendlyExplain()`?
+- [ ] Figure out where the built packages should live / be served from
+- [ ] Open source?
 
 A small, runtime-agnostic, library that explains Python error messages in a friendlier way, inspired by [p5.js's Friendly Error System](https://p5js.org/contribute/friendly_error_system/).
 
 It can be used in browser-based editors (like RPF's [Code Editor web component](https://github.com/RaspberryPiFoundation/editor-ui)) or any environment that executes Python code through Skulpt or Pyodide.
 
 ## Features
 
-- Parses and normalizes errors from Skulpt or Pyodide (via adapters)
+- Parses and normalises errors from Skulpt or Pyodide (via adapters)
 - Matches errors against a copydeck (JSON rules and templates)
 - Copydeck-based explanations can be localised
-- Returns structured explanations or ready-made HTML snippets
-- Designed for both integration into browser editors and standalone tools
+- Returns structured explanations as well as ready-made HTML snippets
 
 ## Usage
 
@@ -91,13 +92,7 @@ Create a clean build for distribution:
 npm run build:all && npm run build:browser
 ```
 
-Output files will be in dist/:
-```
-dist/
-├─ index.js
-├─ index.d.ts
-└─ adapters/...
-```
+Output files will be in `dist/`.
 
 You can now import it elsewhere (see Usage notes):
 

src/engine.ts

@@ -139,7 +139,7 @@ export const explain = (opts: ExplainOptions): ExplainResult => {
     };
   }
 
-  // Optional verbosity shaping (kept small)
+  // not convinced by this implementation, and may decide to drop the verbosity option...
   if (verbosity === "brief") {
     chosen.why = undefined;
     chosen.steps = chosen.steps?.slice(0, 1);