fix(html): render @param docs for rest parameters#809
Open
crowlbot wants to merge 1 commit into
Open
Conversation
The rendered name of a rest parameter carries a `...` prefix (e.g. `...rest`), but JSDoc `@param` tag names are bare identifiers. The parameter-doc lookup keyed off the rendered name, so rest parameters never matched their `@param` tag and their documentation was dropped. Strip the leading `...` when looking up the doc so rest parameters render their description, default and optional flag like any other parameter.
|
|
Member
|
@crowlbot this isnt accurate, as there could be destructuring |
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.
Problem
@paramdocumentation was not rendered for rest/spread parameters in the HTML output (issue #574). Given:the doc for
firstrendered, but the doc forrestwas silently dropped.Cause
When matching
@paramtags to parameters,function.rskeyed the lookup on the rendered parameter name. For a rest parameter,param_name()produces a...-prefixed name (...rest), while the JSDoc@paramtag name is the bare identifier (rest). The keys never matched, so the description, default and optional flag were all lost for rest parameters.Fix
Strip the leading
...from the parameter name before looking up its@paramdoc. Regular parameters are unaffected (their names have no leading dots).Test
Added
html_rest_param_jsdoctotests/html_test.rs, which fails before the change and passes after. The existingdiff_comprehensivesnapshots also pick up the now-rendered doc for a...middlewaresrest parameter, confirming the fix end-to-end.Fixes #574