docs(examples): fix outdated CLI flag names in heatmap_and_track README#2266
Merged
Borda merged 1 commit intoMay 22, 2026
Merged
Conversation
|
|
The README listed `--track_threshold` and `--match_threshold`, but script.py exposes `--track_activation_threshold` and `--minimum_matching_threshold` (the CLI surface is derived from the main() signature by jsonargparse.auto_cli). Following the README as written produced "unknown argument" errors. Aligns the README with the actual CLI surface.
Borda
changed the title
heatmap_and_track README
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #2266 +/- ##
=======================================
Coverage 78% 78%
=======================================
Files 66 66
Lines 8374 8374
=======================================
Hits 6501 6501
Misses 1873 1873 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the examples/heatmap_and_track README so its documented CLI flags match the actual flags generated from script.py’s main() signature via jsonargparse.auto_cli, preventing “unknown argument” errors when following the example.
Changes:
- Renamed
--track_threshold→--track_activation_thresholdin the README. - Renamed
--match_threshold→--minimum_matching_thresholdin the README.
Borda
approved these changes
May 22, 2026
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.
What
The
examples/heatmap_and_track/README.mdlisted two CLI flags that don't exist on the actual script:script.py--track_threshold--track_activation_threshold--match_threshold--minimum_matching_thresholdThe CLI surface is generated from the
main()signature byjsonargparse.auto_cli(script.py:120-123), so the function parameter names (track_activation_threshold,minimum_matching_threshold) are the actual accepted flags. Following the README as written produced "unknown argument" errors.Change
Two-line rename in the "script arguments" section to match the real flag names.
Scope
Documentation-only. No code changes, no behavior change.