Fix typo, update README, and enhance tutorial clarity - #2
Open
haddadanas wants to merge 4 commits into
Open
Conversation
haddadanas
commented
Sep 5, 2026
haddadanas
commented
Collaborator
- Fixed a typo that broke the "Advanced Tutorial" in German
- Updated the README to include information about the plotting script and the plotting workflow
- Made the mu and e selection field active by default to avoid confusion for the students
haddadanas
added
bug
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Enabling mu/e selection by default changes selection semantics (default 0 becomes an active cut) and the new plotting README currently disagrees with the script’s actual CLI defaults/options.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates tutorial and teacher-facing materials, and adjusts selection-field defaults to reduce confusion during the analysis workflow.
Changes:
- Fixes a tutorial step-text key typo (
wilcome→welcome) used by the analysis tutorial. - Makes muon/electron selection fields active by default and adds plotting guidance to the teacher guide (EN/DE).
- Adds documentation for the plotting script under
scripts/.
File summaries
| File | Description |
|---|---|
| ts/tutorial-config.ts | Fixes the analysis tutorial “welcome” step-text key usage. |
| ts/setup.ts | Changes selection-field checkbox initialization (mu/e active by default). |
| scripts/README.md | Adds usage docs for the plotting script. |
| index.html | Adds new teacher-guide plotting section placeholders (i18n-driven). |
| dist/assets/locales/en_guide.json | Adds teacher plotting guide strings (EN). |
| dist/assets/locales/de_guide.json | Adds teacher plotting guide strings (DE). |
Review details
- Files reviewed: 3/6 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+625
to
630
| if (["selMuons", "selElectrons"].includes(key)) { | ||
| createCheckboxContainer(cont, true); | ||
| } | ||
| if (["selPhotons", "maxMETs"].includes(key)) { | ||
| createCheckboxContainer(cont, false); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.