Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tooltips for exception breakpoint filters. (#790) #798

Merged
merged 1 commit into from
Dec 9, 2021

Conversation

int19h
Copy link
Contributor

@int19h int19h commented Dec 2, 2021

No description provided.

{
"filter": "userUnhandled",
"label": "User Uncaught Exceptions",
"default": False,
"description": "Break when exception escapes into library code.",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@luabud @brettcannon For input on the text being used for various exception breakpoint.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Break when exception escapes into library code.",
"description": "Break when an exception escapes into library code.",

Maybe "3rd-party" instead of "library"? No real opinion honestly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has always been a tricky one to name concisely. The only baseline that we have here is "just my code" as the name of the related breakpoint feature. But it's basically "stdlib + site-packages" by default, and there are also ways to customize it. So "third-party" is not necessarily accurate if there are some first-party dependencies that just happen to be installed into site-packages (including venv).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"non-user code" maybe? But also no preference here 😅 library code is also fine as is. a

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Non-user code" is where I started, but then it's kinda redundant wrt the option name; so I wanted the tooltip to give more clues as to what "non-user" actually means.

The other thing is that "user code" makes sense to us, but less so to the actual user - to them, it's "my code"! E.g. consider "just my code" vs "user-code only"... the catch here is that we label the option itself "User uncaught exceptions", so it's already wrong in this sense, tooltip or no tooltip. But we could rename it to "Exceptions not caught in my code" or something like that?

@sonarcloud
Copy link

sonarcloud bot commented Dec 2, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@int19h int19h merged commit baf6121 into microsoft:main Dec 9, 2021
@int19h int19h deleted the 790 branch December 9, 2021 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants