docs: Enhance documentation for pie menu functions in piemenus.js#5628
Merged
walterbender merged 4 commits intosugarlabs:masterfrom Feb 22, 2026
Merged
docs: Enhance documentation for pie menu functions in piemenus.js#5628walterbender merged 4 commits intosugarlabs:masterfrom
walterbender merged 4 commits intosugarlabs:masterfrom
Conversation
Contributor
|
✅ All Jest tests passed! This PR is ready to merge. |
Contributor
Author
|
@omsuneri can you please review this ? |
Contributor
|
@Siddharth-732 please solve merge conflicts...! |
Contributor
|
✅ All Jest tests passed! This PR is ready to merge. |
Contributor
Author
|
@walterbender i have resolve the merge conflict, kindly review this |
Contributor
|
@Siddharth-732 . Please double-check consistency in type annotations and @returns usage across all functions. |
Contributor
|
✅ All Jest tests passed! This PR is ready to merge. |
Contributor
Author
|
@vanshika2720,I checked for consistency throughout my changes, also added @return for all functions. I hope this resolves the issue. |
Contributor
|
✅ All Jest tests passed! This PR is ready to merge. |
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.
fixes #5563
(accidently closed the last PR)
Summary
This PR adds comprehensive JSDoc documentation to key pie menu–related functions in
js/piemenus.js.These functions implement complex UI and musical logic but previously lacked clear inline documentation, making them harder to understand and maintain.
The added JSDoc comments describe each function’s purpose, parameters, return values, and usage context.
Changes Made
Added structured JSDoc documentation to 16 pie menu functions, including:
Helper Functions
setWheelSize()– Responsive pie menu sizinggetPieMenuSize()– Calculates optimal menu size based on canvasenableWheelScroll()– Enables scroll-based rotation for pie menusMusical Selection Menus
piemenuPitches()– Pitch and accidental selectionpiemenuCustomNotes()– Custom note set selectionpiemenuNthModalPitch()– Scale degree selectionpiemenuAccidentals()– Sharp / flat / natural selectionpiemenuNoteValue()– Note duration selectionpiemenuChords()– Chord selection menupiemenuIntervals()– Interval selectionpiemenuModes()– Musical mode selectionpiemenuVoices()– Voice / instrument selectionUtility Menus
piemenuNumber()– Numeric value selectionpiemenuColor()– Color picker pie menupiemenuBasic()– Generic pie menu builderpiemenuBoolean()– Boolean selection menuWhy This Change Is Needed
Testing
Checklist