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

Make the documentation of completionItem larger #69363

Conversation

tamuratak
Copy link
Contributor

@tamuratak tamuratak commented Feb 25, 2019

This is a PR to make the documentation of completionItem larger, which solves #14165 along with commits by @sandy081 solving #67076.

Before:

2019-02-25 21 32 17

After:

2019-02-25 21 28 23

At various positions:

feb-25-2019 21-34-55

@msftclas
Copy link

msftclas commented Feb 25, 2019

CLA assistant check
All CLA requirements met.

@jrieken jrieken assigned joaomoreno and unassigned jrieken Feb 26, 2019
@joaomoreno joaomoreno added this to the Backlog milestone Feb 26, 2019
@joaomoreno joaomoreno added the suggest IntelliSense, Auto Complete label Feb 26, 2019
@tamuratak tamuratak changed the title Make the detail of completionItem larger Make the documentation of completionItem larger Feb 27, 2019
@tamuratak
Copy link
Contributor Author

I found that this PR sovles #29126 too.

@Astrantia
Copy link

@sandy081 @joaomoreno Why not merge this for the next release?

@joaomoreno joaomoreno assigned joaomoreno and unassigned joaomoreno Mar 4, 2019
@tamuratak tamuratak force-pushed the make_detail_of_completion_item_larger branch from 5ff9b1d to 43b2f68 Compare April 22, 2019 12:37
Copy link
Member

@joaomoreno joaomoreno left a comment

Choose a reason for hiding this comment

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

Looks good, but I would put this behind a setting and leave the default as is.

src/vs/editor/contrib/suggest/suggestWidget.ts Outdated Show resolved Hide resolved
@tamuratak
Copy link
Contributor Author

I would like to resolve the conflict if needed.

@joaomoreno
Copy link
Member

Sure, go ahead 👍

@joaomoreno
Copy link
Member

Don't forget this:

Looks good, but I would put this behind a setting and leave the default as is.

@tamuratak
Copy link
Contributor Author

With vs/base/common/marked/marked, the maximum length of lines in code blocks is used to set the width of details if they exist. If not, the width is set 500px when this feature is enabled. When it is disabled, the width is set 330px.

Enabled:

2019-08-18 16 15 35

2019-08-18 16 24 56

Disabled:

2019-08-18 16 26 25

@joaomoreno, fixed reacting to the setting change. Fixed the size of No suggestions.

2019-08-18 16 53 09

@joaomoreno joaomoreno assigned octref and unassigned joaomoreno Sep 17, 2019
@joaomoreno joaomoreno requested review from joaomoreno and removed request for joaomoreno September 17, 2019 07:17
@MOZGIII
Copy link
Contributor

MOZGIII commented Jan 18, 2020

This might not be perfect as it is, however it definitely solves a pain point if the screenshots represent the reality. What if this is merged in as is, and then polished to automatically adapt to the size of the code later? It looks like users can switch to this new mode only if they want to, so this should be good enough for now.

@tamuratak tamuratak force-pushed the make_detail_of_completion_item_larger branch from 2e69e36 to 0ca858a Compare February 6, 2020 13:56
@awulkan
Copy link

awulkan commented Mar 2, 2020

This looks good enough to me for now. Right now the documentation window is barely readable in a lot of cases, and It'd be sad to if a potential solution was stalled for years because it's not 100% perfect. It's better than what we currently have, and I believe it can be improved through incremental updates later on.

@wompeter
Copy link

These tiny popup windows have been a major usability issue for literally years, with people resorting to hacking the CSS and re-hacking it every update. I can't believe the reluctance to deal with the problem when there are solutions like this waiting to go.

@jrieken jrieken closed this Apr 15, 2020
@jrieken
Copy link
Member

jrieken commented Apr 15, 2020

I think we have been pretty clear that the approach of two static sizes (large and not so large) is not what we want. We are looking for dynamic sizing that tries to fit the contents of the suggestion details widget, actually we try to have the same for hovers as well.

@tamuratak
Copy link
Contributor Author

I heard it for the first time.

I think we have been pretty clear that the approach of two static sizes (large and not so large) is not what we want.

Do you mean that you have started implementing a dynamic sizing suggestion widget? Can I try it on a certain branch?

We are looking for dynamic sizing that tries to fit the contents of the suggestion details widget, actually we try to have the same for hovers as well.

@MOZGIII
Copy link
Contributor

MOZGIII commented Apr 15, 2020

I think we have been pretty clear that the approach of two static sizes (large and not so large) is not what we want. We are looking for dynamic sizing that tries to fit the contents of the suggestion details widget, actually we try to have the same for hovers as well.

@jrieken, could you elaborate more on the desired approach? Or link us to a more in-depth discussion on the matter?

@tamuratak
Copy link
Contributor Author

@jrieken in the following gif, for example, are you saying that the width of details should shrink to the actual length of inside texts if they are short?

However, if the width of suggestions details changes too dynamically, it will annoy users.

Apr-15-2020 22-59-36

Moreover, when the width of suggestions changes dynamically, it is difficult to determine the correct position of it. In some cases, we have to change the position dynamically to prevent it going out of the window. And, it will annoy users.

@wompeter
Copy link

I think we have been pretty clear that the approach of two static sizes (large and not so large) is not what we want. We are looking for dynamic sizing that tries to fit the contents of the suggestion details widget, actually we try to have the same for hovers as well.

Is anyone actually looking though? Because this issue has been open in various forms since at least 2016.
#14165

Debugging in vscode is so painful because of this.

@github-actions github-actions bot locked and limited conversation to collaborators May 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
suggest IntelliSense, Auto Complete ux User experience issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants