Effect::checkGate should have a more descriptive comment
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 1.3k
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 7
Description
Enhancement Summary
Effect::checkGate expects the squared RMS value over the current buffer (thanks @DomClark for confirming). This should be stated in the doxygen comment.
Justification
It's an unusual formula, so this should be stated in the doxygen comment.
It has already been done wrong in Lv2Effect and CrossoverEQ (though it's fixed now in Lv2 and for the EQ we opened #5461 )
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search for Effect::checkGate and read its doxygen comment. Update the documentation to state that it expects the squared RMS value over the current buffer, then review the nearby comments and the related Lv2Effect and CrossoverEQ references for consistency. Done means the unusual formula is explicitly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100