microsoft / microsoft/TypeScript
jsdoc "object." fails where "Object." works.
Open
Nobody has claimed this yet.
Awaiting More Feedback
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Object.<string,number> works
object.<string,number> fails
jsdoc eslint likes lower case object, see here: https://github.com/gajus/eslint-plugin-jsdoc/blob/master/.README/rules/check-types.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the two JSDoc examples in the TypeScript repository and trace the JSDoc type parsing entry point that handles Object.<string,number> and object.<string,number>. Compare the behavior with the eslint-plugin-jsdoc guidance linked in the issue; done means the lowercase form is accepted consistently with the uppercase form and the relevant regression coverage passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100