docs: document deterministic multi-family SVG rendering#140
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the multi_family_admissibility_benchmark.md documentation by adding a section for deterministic SVG rendering and a corresponding test command in the validation section. Feedback suggests improving the formatting of the new documentation section by using code blocks for commands to ensure consistency with existing sections and improve usability for copy-pasting.
| The benchmark also includes a deterministic SVG rendering step: | ||
|
|
||
| - Input: `artifacts/multi_family_admissibility_results.json` | ||
| - Output: `artifacts/multi_family_admissibility_curves.svg` | ||
| - Script: `scripts/render_multi_family_admissibility_svg.py` | ||
| - npm command: `npm run generate:multi-family-svg` |
There was a problem hiding this comment.
For consistency with the 'Regeneration commands' section (lines 56-66), consider using code blocks for the SVG regeneration commands and including the Python script execution command explicitly. This makes the documentation easier to follow and the commands easier to copy-paste.
Suggested structure:
The benchmark also includes a deterministic SVG rendering step:
- Input: `artifacts/multi_family_admissibility_results.json`
- Output: `artifacts/multi_family_admissibility_curves.svg`
Use either command to regenerate the SVG:
```bash
python scripts/render_multi_family_admissibility_svg.pynpm run generate:multi-family-svg
Motivation
Description
docs/benchmarks/multi_family_admissibility_benchmark.mdthat references the input artifactartifacts/multi_family_admissibility_results.json, outputartifacts/multi_family_admissibility_curves.svg, renderer scriptscripts/render_multi_family_admissibility_svg.py, and npm commandnpm run generate:multi-family-svg, and updated the validation commands to includepytest tests/test_multi_family_svg_renderer.py -q.Testing
npm run check(which runs the repository-wide layout/typecheck/validate/build/test pipeline) and all tests passed; the targeted pytest runpytest tests/test_multi_family_svg_renderer.py -qwas included in the test suite and passed as part of the run.Codex Task