Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Overloads crowd out documentation in IntelliSense #1116

Closed
mattbierner opened this issue Apr 2, 2021 · 4 comments
Closed

Overloads crowd out documentation in IntelliSense #1116

mattbierner opened this issue Apr 2, 2021 · 4 comments
Assignees
Labels
enhancement New feature or request needs decision Do we want this enhancement?

Comments

@mattbierner
Copy link

mattbierner commented Apr 2, 2021

Issue Type: Bug

Repro

  1. In a python file:
import re
  1. Type re.sub and look at IntelliSense

Bug
The list of 4 overloads for re.sub crowds out the arguably much more useful documentation on what this function does

Screen Shot 2021-04-02 at 12 55 11 AM

Compared this with a similar overloaded function in JS/TS, which lists the common overload first and then indicates that additional overloads are available:

Screen Shot 2021-04-02 at 1 05 50 AM

Extension version: 2021.3.4
VS Code version: Code - Insiders 1.55.0-insider (05ce54df77c242b1b8ea5fd93d720c62fdb183e6, 2021-03-25T05:12:59.457Z)
OS version: Darwin x64 20.3.0

System Info
Item Value
CPUs Intel(R) Core(TM) i7-7700K CPU @ 4.20GHz (8 x 4200)
GPU Status 2d_canvas: enabled
gpu_compositing: enabled
metal: disabled_off
multiple_raster_threads: enabled_on
oop_rasterization: enabled
opengl: enabled_on
protected_video_decode: unavailable_off
rasterization: enabled
skia_renderer: disabled_off_ok
video_decode: enabled
webgl: enabled
webgl2: enabled
Load (avg) 3, 3, 3
Memory (System) 40.00GB (0.03GB free)
Process Argv --crash-reporter-id cefe23df-690f-4b1b-9ce9-e004d3be2745
Screen Reader no
VM 0%
@github-actions github-actions bot added the triage label Apr 2, 2021
@mattbierner
Copy link
Author

Discussed in #612. However that fix for that issue was improving the formatting of the overload. This issue is about all these overloads being listed at the top of IntelliSense

@mattbierner
Copy link
Author

Another example for the open function:

Screen Shot 2021-04-03 at 6 47 07 PM

@judej judej added the enhancement New feature or request label Apr 5, 2021
@github-actions github-actions bot removed the triage label Apr 5, 2021
@savannahostrowski savannahostrowski added the needs investigation Could be an issue - needs investigation label Jun 16, 2021
@heejaechang heejaechang self-assigned this Apr 12, 2022
@heejaechang heejaechang added needs decision Do we want this enhancement? and removed needs investigation Could be an issue - needs investigation labels Apr 12, 2022
@heejaechang
Copy link
Contributor

@judej we need decision on this. I think we talked about it long time ago but didn't decide. and I think Savannah did some user study on this as well?

@judej
Copy link
Contributor

judej commented Apr 18, 2022

Converting this issue to an enhancement discussion for comments and upvotes

@microsoft microsoft locked and limited conversation to collaborators Apr 18, 2022
@judej judej converted this issue into discussion #2577 Apr 18, 2022
@judej judej removed their assignment Jul 27, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
enhancement New feature or request needs decision Do we want this enhancement?
Projects
None yet
Development

No branches or pull requests

4 participants