Skip to content

Comments

Fix #89900 - improve text on editor.showFoldingControls setting#89919

Merged
aeschli merged 1 commit intomicrosoft:masterfrom
gjsjohnmurray:fix-89900
Feb 4, 2020
Merged

Fix #89900 - improve text on editor.showFoldingControls setting#89919
aeschli merged 1 commit intomicrosoft:masterfrom
gjsjohnmurray:fix-89900

Conversation

@gjsjohnmurray
Copy link
Contributor

This PR fixes #89900

As well as clarifying the meaning of the setting, descriptions have been added to the two values it can take.

image

image

@chrisjj
Copy link

chrisjj commented Feb 3, 2020

Only show the folding controls when the mouse is over the gutter.

That does not accord with behaviour. Expand (">") is shown regardless.

I'm guessing that behaviour is a bug, but have held off reporting it until I understand this muddled area more e.g. why there's second expand button at the line end ("...") - with no corresponding collapse button.

Meanwhile I'm pointing this out in case you, like I, think it better for the labelling to accord with erroneos behavior meanwhile.

@gjsjohnmurray
Copy link
Contributor Author

Only show the folding controls when the mouse is over the gutter.

That does not accord with behaviour. Expand (">") is shown regardless.

@chrisjj good point. I suggest "Hide 'Fold' controls unless the mouse is over the gutter. 'Unfold' controls are always shown."

My suggestion avoids using 'expand' and 'collapse' because those would be inconsistent with documentation and command names.

@aeschli aeschli assigned aeschli and unassigned alexdima Feb 3, 2020
@aeschli aeschli self-requested a review February 3, 2020 16:16
@chrisjj
Copy link

chrisjj commented Feb 3, 2020

I suggest "Hide 'Fold' controls unless the mouse is over the gutter. 'Unfold' controls are always shown."

In this context, Fold for Collapse is very ambiguous. And control is needlessly unspecific.

I suggest:

Hide Collapse buttons unless the mouse pointer is over the gutter. Expand buttons are always shown.

@gjsjohnmurray
Copy link
Contributor Author

The name of the setting itself refers to them as controls. Nor do they have the conventional appearance of buttons. Indeed there are two distinct forms of the Unfold controls, one being the > chevron and the other the end-of-line ellipsis.

I disagree about the ambiguity of Fold in this context, since it contrasts with Unfold in the second sentence. Also, Fold and Unfold are the standard terms in VS Code documentation and the command names.

@chrisjj
Copy link

chrisjj commented Feb 4, 2020

The name of the setting itself refers to them as controls.

Hardly an authority, right? :).

Nor do they have the conventional appearance of buttons.

Only because the border shown in the docs has been removed for some reason.

However, that doesn't change the fact they are buttons.

I disagree about the ambiguity of Fold in this context, since it contrasts with Unfold in the second sentence.

OK, so your "@chrisjj good point." above is cancelled, right? Because your 'folding' there was excluing my Expand.

Also, Fold and Unfold are the standard terms in VS Code documentation

... relying on expand and collapse for clarification :) e.g.

"Fold (Ctrl+Shift+[) folds the innermost uncollapsed region at the cursor."

@aeschli aeschli added this to the February 2020 milestone Feb 4, 2020
@aeschli aeschli added the editor-folding Editor code folding issues label Feb 4, 2020
@aeschli
Copy link
Contributor

aeschli commented Feb 4, 2020

Sorry for the inconsistency of terms.

  • In the UI it's always fold / unfold.
  • The folding controls are also called folding actions in the doc. I will change it there. Better be consistent.

@aeschli aeschli merged commit 24737bb into microsoft:master Feb 4, 2020
@aeschli
Copy link
Contributor

aeschli commented Feb 4, 2020

Thanks @gjsjohnmurray !

@gjsjohnmurray gjsjohnmurray deleted the fix-89900 branch February 4, 2020 12:13
@chrisjj
Copy link

chrisjj commented Feb 5, 2020

The folding controls are also called folding actions in the doc.

Where please? I don't see that in https://code.visualstudio.com/docs/editor/codebasics Folding.

@aeschli
Copy link
Contributor

aeschli commented Feb 6, 2020

Sorry, folding icons.

@chrisjj
Copy link

chrisjj commented Feb 6, 2020

Thanks. I agree that folding controls is better than folding icons. Though still I think folding buttons is best :)

@github-actions github-actions bot locked and limited conversation to collaborators Mar 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

editor-folding Editor code folding issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Settings Show folding controls answers have reverse effect

4 participants