feat: jsdoc priority tag #753
Merged
Conversation
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
kt3k
reviewed
Dec 26, 2025
|
|
||
| match (p1, p2) { | ||
| (Some(p1), Some(p2)) => p1.cmp(p2), | ||
| (Some(p1), None) if p1 == &0 => Ordering::Equal, |
Member
There was a problem hiding this comment.
Looks reasonable to handle None being equal to 0
kt3k
approved these changes
Dec 26, 2025
Member
kt3k
left a comment
kt3k
left a comment
There was a problem hiding this comment.
This is useful for organizing API docs page (especially in JSR) in more reasonable form. I think this is worth trying. LGTM
Member
|
BTW do we document what tags are supported in |
Member
Author
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.
This PR adds a new jsdoc tag:
@priority.It takes a number value, and acts like
z-indexin css does: a bigger number means it has higher priority, 0 same as unset and negative lower priority.The priority affects in what order symbols are displayed in symbol lists in the HTML renderer, with greater priority showing up first.
This is especially useful for JSR, where there may be some exports you want to prioritize (or "feature").