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

Improve explanation of "compacted with the parent" #101434

Closed
weinand opened this issue Jun 30, 2020 · 2 comments
Closed

Improve explanation of "compacted with the parent" #101434

weinand opened this issue Jun 30, 2020 · 2 comments
Assignees
Labels
debug Debug viewlet, configurations, breakpoints, adapter issues insiders-released Patch has been released in VS Code Insiders polish Cleanup and polish issue verified Verification succeeded
Milestone

Comments

@weinand
Copy link
Contributor

weinand commented Jun 30, 2020

Testing #101009

The comment for the new "noCompact" option says:

Controls if the debug session created will be compacted with the parent in the CALL STACK view. Compact with the parent is only done if the session is the only child of its parent session. Default is to compact.

IMO "compacted with the parent" is not very clear to me. I think this can be improved to something like:

Controls if the debug session's parent session is shown even if it has only a single child. Default is to hide the parent session in this case in order to make the tree more compact.

@connor4312 any other suggestions from a native speaker?

@weinand weinand added the debug Debug viewlet, configurations, breakpoints, adapter issues label Jun 30, 2020
@connor4312
Copy link
Member

I like the rewording. Something I was initially confused about was where noCompact applied -- to the subtree, children, parents? Maybe something like this:

By default, debug sessions with a single child are hidden in the CALL STACK view to make the tree more compact. If noCompact is true, then the new debug session will never hide its parent.

@isidorn isidorn added this to the June 2020 milestone Jul 1, 2020
@isidorn isidorn added the polish Cleanup and polish issue label Jul 1, 2020
@isidorn isidorn closed this as completed in 34928dd Jul 1, 2020
@isidorn
Copy link
Contributor

isidorn commented Jul 1, 2020

Thanks for feedback!
Landed on

Controls if the debug session's parent session is shown in the CALL STACK view even if it has only a single child.
By default, debug sessions with a single child are hidden in the CALL STACK view to make the tree more compact.
If noCompact is true, then the debug session will never hide its parent.

@weinand weinand added the verified Verification succeeded label Jul 1, 2020
@github-actions github-actions bot locked and limited conversation to collaborators Aug 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
debug Debug viewlet, configurations, breakpoints, adapter issues insiders-released Patch has been released in VS Code Insiders polish Cleanup and polish issue verified Verification succeeded
Projects
None yet
Development

No branches or pull requests

4 participants
@weinand @isidorn @connor4312 and others