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

Parameter documentation (info) not showing #1739

Closed
ghost opened this issue Aug 27, 2017 · 8 comments
Closed

Parameter documentation (info) not showing #1739

ghost opened this issue Aug 27, 2017 · 8 comments

Comments

@ghost
Copy link

ghost commented Aug 27, 2017

Environment data

dotnet --info output:

Product Information:
 Version:            2.0.0
 Commit SHA-1 hash:  cdcd1928c9

Runtime Environment:
 OS Name:     Windows
 OS Version:  10.0.15063
 OS Platform: Windows
 RID:         win10-x64
 Base Path:   C:\Program Files\dotnet\sdk\2.0.0\

Microsoft .NET Core Shared Framework Host

  Version  : 2.0.0
  Build    : e8b8861ac7faf042c87a5c2f9f2d04c98b69f28d

VS Code version: 1.15.1
C# Extension version: 1.12.1

Steps to reproduce

  1. String.Format(
  2. throw new Exception(

There's no parameter documentation (info) showing when calling this method (ór pressing Ctrl+Shift+Space) (1). The same happens when throwing a new Exception (2).

Expected behavior

Show parameter documentation.

Actual behavior

Not showing parameter documentation.

@ghost ghost changed the title Parameter Info not showing Parameter documentation (info) not showing Aug 27, 2017
@DustinCampbell
Copy link
Member

Hi! Just to clarify what you are reporting, are you unable to get the signature help popup to display (with the possible signature overloads). Or, is the signature help popup displaying, but without any documentation text?

@ghost
Copy link
Author

ghost commented Aug 28, 2017 via email

@DustinCampbell
Copy link
Member

Thanks for clarifying. I can definitely repro that. FWIW, I see documentation text a bit inconsistently. For example, I don't see it on String.Format(...) or new Exception(...), but I do see it for Console.WriteLine(...). I'm betting this is related to #1551.

@ghost
Copy link
Author

ghost commented Aug 28, 2017

It seems related. The comment:

@terrajobst, @richlander: Poking around a bit, it appears that the NETStandard.Library packages don't appear to contain XML documentation like, say, the ASP.NET packages do, which means that users don't get documentation on hover or completion in VS Code for core types and members. Is there are plan to start including documentation so that users get a good experience?

Seems to apply, but I have no knowledge of the current state of the application to see what has changed in the mean time.

@ghost ghost closed this as completed Aug 28, 2017
@DustinCampbell
Copy link
Member

I'd like to look at this separately. It seems like it might be the same, but I'd rather keep this around.

@ghost ghost closed this as completed Aug 28, 2017
@ghost ghost reopened this Aug 28, 2017
@ghost ghost closed this as completed Aug 28, 2017
@DustinCampbell
Copy link
Member

Again, I'd really like to keep this issue open so we can track it separately. Thanks!

@gregg-miskelly
Copy link
Contributor

@csanthoshi This is the C# extension repo, so your problem is not related to this issue. You want to ask on the GitHub for the Ruby VS Code extension. I would also generally suggest against commenting on closed issues unless you are pretty sure the issues are related.

@JoeRobich
Copy link
Member

not able to reproduce this issue with the current release.

@JoeRobich JoeRobich closed this as not planned Won't fix, can't repro, duplicate, stale Nov 8, 2024
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

4 participants