microsoft / microsoft/TypeScript-Website
Documentation Missing for Shorthand Commands -p / -v / -b
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.6k
- Forks
- 1.5k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 7
Description
Page URL: Compiler Options
Issue:
Documentation for tsc command is completely lacking shorthand versions:
-palias for--project-valias for--version-balias for--build
(Or, if this information does exist somewhere in the docs, it needs to at least be linked on the affected page.)
I understand you would prefer a PR instead as this doesn't seem that critical (although I think any completely lacking documentation is pretty critical. I see the -p / --p option used everywhere, but had to look in the source to confirm what it did). I'm extremely busy currently, but I'll happily make a PR for this as soon as I have some time, with which I'll tie in and close this issue.
Contributor guide
No contributing guide indexed for this repository
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
Open the Compiler Options page linked in the issue and check how command-line options are presented. Document the -p, -v, and -b aliases for --project, --version, and --build, or link to existing documentation; done means readers can find all three shorthand commands there.
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
- 58/100