microsoft / microsoft/TypeScript
Typo in `String#match` (lib.es2015.symbol.wellknown)
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
TypeScript Version: 3.0.0-dev.201xxxxx
Search Terms:
typos, string, lib, es2015.symbol.wellknown
I've wiped the majority of the template since this is a typo report.
I was originally going to just make a PR but the template had:
- There is an associated issue in the
Backlogmilestone (required)
The typo itself is that String#match in lib.es2015.symbol.wellknown has it's param description pasted in the middle of it's method description:
My PR replaced it with "with a regular expression" - Let me know what the correct way to proceed with this is 🙂
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
The typo is in src/lib/es2015.symbol.wellknown.d.ts around lines 209-212; start by reading the String#match declaration comments there. Correct the duplicated parameter description in the method description, then verify that the declaration text accurately describes matching with a regular expression.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100