microsoft / microsoft/TypeScript
Module plugin template is misleading
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Expected behavior:
I followed the template exactly and it can't do what it's claiming you can do. I would expect from the template that I could extend an existing module with a new function.
https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-plugin-d-ts.html
Actual behavior:
I am unable to extend the existing module with a new function.
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 with the linked module-plugin template and reproduce the report using the linked TS-Plugin-HW repository. Compare the template's stated capability with the observed behavior; done means the documentation accurately explains whether and how an existing module can be extended with a new function.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100