Add JSDoc comment for WIDGET_PRIORITY constant#3528
Draft
Lang-Qiu wants to merge 1 commit into
Draft
Conversation
finetjul
reviewed
Jun 8, 2026
| @@ -1,3 +1,4 @@ | |||
| /** @type {number} The priority used for widget interaction in VTK.js. */ | |||
Member
There was a problem hiding this comment.
you might want to mention as well if high numbers are high or low priority
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
3 participants
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.
Problem
The public constant
WIDGET_PRIORITYinSources/Widgets/Core/AbstractWidget/Constants.jslacks documentation, which may lead to confusion for users regarding its purpose and type information. Improving documentation enhances code readability and usability in the VTK.js ecosystem.Changes
Added a JSDoc comment to
WIDGET_PRIORITYto specify its type (number) and describe its role as the priority used for widget interaction in VTK.js.Verification