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

Built-in property and method help should include fully qualified type name #1118

Closed
pcgeek86 opened this issue Jan 13, 2017 · 7 comments
Closed
Milestone

Comments

@pcgeek86
Copy link

Environment data

dotnet --info output:

.NET Command Line Tools (1.0.0-preview2-1-003177)

Product Information:
 Version:            1.0.0-preview2-1-003177
 Commit SHA-1 hash:  a2df9c2576

Runtime Environment:
 OS Name:     Mac OS X
 OS Version:  10.12
 OS Platform: Darwin
 RID:         osx.10.12-x64

VS Code version: 1.8.1
C# Extension version: 1.6.2

Expected behavior

When examining the built-in help documentation for C# properties and methods, the fully qualified type name of the member should be shown.

For example, in the following screenshot, only the RegionEndpoint type name is shown, but that type belongs to the Amazon namespace. So, the help docs should show: Amazon.RegionEndpoint.

It should also show the type's type as well: eg. struct, class, enum, etc.

2017-01-13_11-37-59

http://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Amazon/TRegionEndpoint.html

Actual behavior

Only the type name is shown, omitting the namespace that it belongs to, and type (class, enum, struct, etc.) .

Cheers,
Trevor Sullivan
Docker Captain
Microsoft MVP: Cloud & Data Center Management
https://trevorsullivan.net
https://twitter.com/pcgeek86

@DustinCampbell
Copy link
Member

Thanks for the note. We'll have much better support for the text in tooltips once the new Quick Info API is available from Roslyn (dotnet/roslyn#13623)

@rchande
Copy link

rchande commented Jun 13, 2018

@DustinCampbell @akshita31 It looks like Dustin's PR dotnet/roslyn#20554 is merged. We can probably replace the existing TypeLookup code with.

@rchande rchande added this to the 1.16 milestone Jun 13, 2018
@DustinCampbell
Copy link
Member

@rchande, looking closer at the screenshot, does this look like a hover tooltip or the completion list?

@rchande
Copy link

rchande commented Jun 14, 2018

@DustinCampbell You're right, that does look like a completion list. I think we still have a separate work item to go consume your quickinfo API. Thoughts?

@DustinCampbell
Copy link
Member

Yeah, I was planning to work on supporting the new Quick Info API once the 2.9.0 Roslyn packages show up on NuGet (they're not there yet).

@rchande
Copy link

rchande commented Jun 18, 2018

@DustinCampbell I know @akshita31 wanted to start doing more work on the omnisharp-roslyn side. Do you think this would be a good workitem for her to pick up?

@rchande rchande modified the milestones: 1.16, 1.17 Sep 18, 2018
@rchande rchande modified the milestones: 1.17, 1.18 Jan 2, 2019
@JoeRobich
Copy link
Member

Closing as Hover and Completion documentation is much improved since this issue was opened. Please open a new issue if you run into problems with documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants