dotnet / dotnet/vscode-csharp

Enhance accessibility: Debugger description rephrasing/add console info

Open
#5,631 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
3.1k
Forks
737
Avg merge
18h 40m
Merged PRs (30d)
31

Description

## Is your feature request related to a problem? Please describe.
There is currently an issue with how people can comprehend the usage/functionality of the debugging flag in the omnisharp settings.
scenario a: inexperienced/disabled person sees this text:
![grafik](https://user-images.githubusercontent.com/106652912/225328520-b62b5734-b473-414e-9466-0a6ce3ec8273.png)
Now there is a possibility they don't understand what this does and confuse the option with *Game Engine Debugging* and tick it by accident.
I spent **7 months** trying to find out what went wrong with my program and had to annoy a lot of people to find out what was wrong. Born from the false assumption I needed this to be enabled for game engine debugging to work/benefit from. I deactivated my intellisense because of its general functionality. Yes there is no guarantee to ensure nobody will accidentally tick this, but we can minimize the problem a lot.

## Describe the solution you would like
Rephrase this ominous description to a degree that people with little understanding know: "DON'T TOUCH UNLESS YOU'RE ASKED TO BY STAFF MEMBERS." A warning. A highlight. An info in the OmniSharp output console that OmniSharp will not connect because debugging is activated. Make it obvious that this should be left unticked in 99% of use cases.

## Applicable Scenarios
Somebody scrolls through the settings and sees this and doesn't tick the option out of pure curiosity/misunderstanding. Or somebody who accidently has done so is getting a warning whenever they press "RestartOmnisharp" and the concerned option will open up in the settings window if they press a button, or the sort. (Can be dismissed but re-enabled on restart or the like).

## Describe alternatives you've considered
Disable the tickbox with a password. Send the password to users that actually need to use it in case of bug solving.

## Additional context
Add any other context or screenshots about the feature request here.

The concerned text is in this file at line 1064. https://github.com/OmniSharp/omnisharp-vscode/blob/master/package.json

Settings:
![grafik](https://user-images.githubusercontent.com/106652912/225339466-353f60c2-8467-45b4-b815-947157f44134.png)

For the Console, I don't know the limitations. It's just a design mockup example. You get the idea.

Console:
![grafik](https://user-images.githubusercontent.com/106652912/225336562-ff5f8822-236d-480d-83a7-1a78b10e25d5.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.