docs(compiler): fix four JSDoc @param errors in checker.ts#63669
docs(compiler): fix four JSDoc @param errors in checker.ts#63669CYANO-01 wants to merge 1 commit into
Conversation
Four documentation-only fixes in src/compiler/checker.ts:
1. Fix swapped JSDoc type/name in getAccessibleSymbolChainFromSymbolTable:
`@param {ignoreQualification} boolean` → `@param {boolean} ignoreQualification`
2. Fix @param name typo in isSymbolAccessible JSDoc:
`shouldComputeAliasToMakeVisible` → `shouldComputeAliasesToMakeVisible`
(matches the actual parameter name and description fix: 'mark' → 'marked')
3. Fix stale @param name in getIndexTypeForMappedType JSDoc:
`noIndexSignatures` → `indexFlags` (the parameter was renamed but doc was not updated)
4. Remove ghost @param key from copySymbol JSDoc:
copySymbol(symbol, meaning) has no `key` parameter; the doc line was left over
from an earlier signature.
No runtime behaviour is affected.
typescript-automation
Bot
added
the
For Uncommitted Bug
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
1 similar comment
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
There was a problem hiding this comment.
✅ Ready to approve
The changes are documentation-only and correct in intent, with only minor wording/grammar nits noted.
Pull request overview
This PR fixes four JSDoc @param documentation inaccuracies in src/compiler/checker.ts (type/name ordering, stale/mismatched parameter names, and removal of a non-existent parameter), with no intended runtime behavior changes.
Changes:
- Corrected
@paramtype/name ordering forignoreQualificationingetAccessibleSymbolChainFromSymbolTable. - Updated mismatched/stale
@paramnames inisSymbolAccessibleandgetIndexTypeForMappedType. - Removed a “ghost”
@param keyentry fromcopySymbol’s JSDoc.
File summaries
| File | Description |
|---|---|
| src/compiler/checker.ts | Fixes several incorrect/stale JSDoc @param entries to match current function signatures. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
| * @param enclosingDeclaration a Node containing reference to the symbol | ||
| * @param meaning a SymbolFlags to check if such meaning of the symbol is accessible | ||
| * @param shouldComputeAliasToMakeVisible a boolean value to indicate whether to return aliases to be mark visible in case the symbol is accessible | ||
| * @param shouldComputeAliasesToMakeVisible a boolean value to indicate whether to return aliases to be marked visible in case the symbol is accessible |
| * Copy the given symbol into symbol tables if the symbol has the given meaning | ||
| * and it doesn't already existed in the symbol table |
|
The TypeScript repo is closed for development; PR should be in the typescript-go repo. Please see the top section of CONTRIBUTING.md and pinned issue #62963. |
Problem
Four JSDoc documentation errors found in
src/compiler/checker.ts, all docs-only — no runtime behaviour changes.1. Swapped
{type}andnameingetAccessibleSymbolChainFromSymbolTableThe JSDoc tag format is
@param {type} name description. Here the identifier name was placed in braces and the type was written as the name, making it unreadable by JSDoc tooling.2. Typo in
@paramname forisSymbolAccessibleThe documented name
shouldComputeAliasToMakeVisible(nos) does not match the actual parametershouldComputeAliasesToMakeVisible. Also fixed adjacent grammar: "mark" → "marked".3. Stale
@paramname ingetIndexTypeForMappedTypeThe parameter was renamed from
noIndexSignatures: booleantoindexFlags: IndexFlagsbut the JSDoc was not updated.4. Ghost
@param keyincopySymbolcopySymbol(symbol: Symbol, meaning: SymbolFlags)has nokeyparameter; the line was left over from an earlier signature.All four are docs-only changes. No runtime behaviour is affected.