Conversation
docs/presets.md described 9 of the 12 factory presets shipped in presets/factory/*.json. Three v0.3.0 additions were missing: Circuit Foundation, Circuit Grind, and Circuit Knife. Added a row for each, derived from the preset's actual stored parameter values against the plugin's defaults (src/params/ParameterLayout.cpp and docs/manual.md's parameter reference), and removed the now-resolved "not described below yet" caveat from the intro. Closes #117
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.
Summary
docs/presets.mddescribed 9 of the 12 factory presets shipped inpresets/factory/*.json. Added rows for the three v0.3.0 additions that were missing: Circuit Foundation, Circuit Grind, and Circuit Knife.src/params/ParameterLayout.cppand cross-checked againstdocs/manual.md's Circuit-engine parameter reference - not guessed from the preset name.What each preset actually does (from stored values, not the name)
Out of scope
The issue's Definition of Done also asks for a test asserting
docs/presets.mdandPresetManager::getAllPresets()can't drift apart again. That requires touchingtests/, which is outside this PR's scope (docs-only). Flagging so a follow-up can add it.Closes #117
Test plan
presets/factory/*.jsonnamefield against the new table - all 12 are present verbatim.src/params/ParameterLayout.cppdefaults anddocs/manual.md's Circuit-engine parameter reference.