Function tooltip shows documentation for its parameter

[mcon]

Summary

I believe this change should fix this issue #7455, and have confirmed that it appears to do so when running an instance of ReSharper with this change built into it.
The method in question that's been changed LinesBefore, was behaving more like LinesAfter.

Testing

• Manual testing with Rider
• Added a new testcase which should cover this case, though I've not been able to run it due to a "did not resolve mscorelib" error when trying to run the FCS tests (I'm running on Windows, nothing out of the ordinary) - if someone could point me to how to go about running them, that would be great.

[dnfclas]

All CLA requirements met.

[cartermp]

Looks good, just a minor nit

[auduchinok]

A failure here:

fsharp/vsintegration/tests/UnitTests/LegacyLanguageService/Tests.LanguageService.QuickInfo.fs

Line 2979 in 7780cab

this.AssertQuickInfoContainsAtStartOfMarker (fileContent, "(*Marker1*)", "x1 param!")

@cartermp Is it OK that the test case seems to run (and fail) twice?

[mcon]

I'm getting a build error when trying to build the failing unit tests in question on master, is anyone able to suggest what the problem might be?

C:\Users\Matt\fsharp\tests\FSharp.Build.UnitTests\FSharp.Build.UnitTests.fsproj : error MSB4057: The target "_GetRestoreSettingsPerFramework" does not exist in the project.

[cartermp]

@auduchinok Probably not, no 🙂

[cartermp]

@mcon do you see that error when you build in VS?

[mcon]

When I use the command line build.cmd - I've got VS installed, but don't use use it as my IDE. Could be something to do with the fact I'd also built fcs in the same workspace - maybe new workspace time for me...

Managed to get things building, and tests running, looking at the failing test, it seems that the savedGrabPoints don't distinguish between parameters and function names, meaning fixing functions documentation breaks parameter documentation - I've found myself in pars.fsy - I'll have a go to see whether I'm able to fix this.

[mcon]

So, I've taken a look here @cartermp, and the secondary problem (which I've now resolved) was that the "grab point" for bindings was after the headBindingPattern, and so the XML lines which were being picked up included XML comments on the function arguments (which, for a tooltip on a function, I don't think is desirable). I've resolved this by putting a grab point at the start of the headBindingPattern, so that only the XML comment above the binding is picked up, and then one at the end of the pattern, so that any XML comments on arguments aren't picked up erroneously by other bindings down the file.

I wanted to have the XML comments on the arguments show up in tooltips too, but though I was able to add the grab points in the right place, I wasn't able to work out where to store the comments in such a way that they could be retrieved later, after parsing, by the tooltip. As a result I've not included this enhancement, and have just stuck to fixing the bug.

Worth noting that prior to this change, XML comments on the function arguments didn't show up in the tooltips - this behaviour isn't altered as part of this PR.

[cartermp]

@mcon makes sense! Just fixing the bug here is definitely fine. Thanks!