For variables, the decl field contains the parent function instead of the variable name and type

[ramya-rao-a]

From @enitihas on January 2, 2017 3:59

I recently changed the option "go.docsTool" to gogetdoc. However, now when I hover over a local variable in any function, it shows me the function name instead of type information of the variable. However, hover works correctly for function arguments.

Copied from original issue: microsoft/vscode-go#703

[ramya-rao-a]

@zmb3 The decl property in the json output from gogetdoc contains the function declaration instead of the variable declaration in such cases

[ramya-rao-a]

From @zmb3 on January 4, 2017 4:6

The current behavior is to ascend the AST until we get to a decl that has [may have] documentation. In this case, tests being a local variable doesn't, and so we keep moving up the AST until we see Test_checkError().

At the time, I thought this behavior made sense. Recall that gogetdoc was originally written for the sole purpose of extracting documentation, not necessarily to provide a tooltip.

I see how this can be confusing, especially now that the tool is being used to provide a tooltip for the item under the cursor. We should try to be as accurate as possible at describing what is under the cursor.

Please create an issue upstream and link it here, I'll be happy to take a look. Bonus points for a repro with actual/expected output :-)

[ramya-rao-a]

Repro:

Expected Output:

[zmb3]

@ramya-rao-a please update and let me know if this works for you :-D

[ramya-rao-a]

Thanks @zmb3. Variables are now good, but something happened to the types.

For example:

type ABC struct {
	a int
	b int
	c int
}

The decl field for ABC above is ABC struct {... instead of type ABC struct { ...

[zmb3]

Thanks for catching that @ramya-rao-a, I should have had done it in a separate branch and had you try it out first.

Should be fixed now.

[ramya-rao-a]

Thanks @zmb3 Looks good now!