microsoft / microsoft/TypeScript
Non-Nullable Objects in params don't have properties parsed
Open
Nobody has claimed this yet.
Domain: JSDoc
Needs Investigation
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.5.2
Search Terms: object param
Code
/**
* Converts a type to a markdown string.
* @param {!Object} [opts]
* @param {boolean} [opts.narrow] Combine type and description.
*/
Expected behavior:
Actual behavior:
Playground Link:
Related Issues:
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
No file or test is named. Start by reproducing the behavior from the issue's JSDoc example in TypeScript 3.5.2, then trace the JSDoc parameter parsing path; done means properties of the non-nullable object parameter are parsed as shown by the expected behavior.
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
- 38/100