microsoft / microsoft/vscode-cpptools
C++ launch json documentation wrong (outdated)
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
I noticed that the C++ Launch JSON documentation is outdated/incorrect.
For example, it suggests setting externalConsole but VS Code says that key doesn't exist: "Property externalConsole is not allowed."
I found some issues related to this, suggesting the docs are no longer up to date:
- https://github.com/microsoft/vscode-cpptools/issues/6805
- https://github.com/microsoft/vscode-cpptools/issues/6939
- https://github.com/microsoft/vscode-docs/issues/5518
- https://github.com/microsoft/vscode-cpptools/pull/6794
I started looking into this because of a StackOverflow question: https://stackoverflow.com/questions/79626471/c-debugger-terminates-instead-of-waiting-for-input-in-vscode-on-mac
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 C++ Launch JSON documentation section linked in the issue, focusing on the externalConsole entry, then compare it with the current VS Code C++ extension behavior and the linked reports. Done means the documentation accurately describes supported launch configuration properties and no longer recommends an invalid key.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100