Fix incorrect panic condition in Key::from_f documentation - #139
Merged
Conversation
Closed
Copilot
AI
changed the title
[WIP] Fix comment in from_f function about panicking behavior
Fix incorrect panic condition in Key::from_f documentation
May 28, 2026
Contributor
|
@copilot whwre is the code change? |
The documentation incorrectly stated the function panics when n == 0 || n > 12, but the code actually handles n == 0 (returning Key::F0) and only panics when n > 12. Updated the documentation to accurately reflect this behavior.
- Replace manual ok() implementation with .ok() method - Replace unwrap after is_some() with if-let pattern
Contributor
Author
The code changes are now visible! I've pushed two commits:
All 46 tests pass with these changes. |
deepu105
approved these changes
May 28, 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.
The documentation for
Key::from_f()incorrectly stated the function panics whenn == 0 || n > 12, but the code actually handlesn == 0(returningKey::F0) and only panics whenn > 12.Changes
Ifn == 0 || n > 12→ `If `n > 121 -> F1, etc...→0 -> F0, 1 -> F1, etc...to clarify that F0 is supportedBefore
After
All 46 existing tests pass with these changes.