Corrected (?) F# signature of Receive method #2754
Conversation
The `Receive` method's F# signature was incorrect—the remoteEP parameter was missing: ``` xml <MemberSignature Language="F#" Value="member this.Receive : -> byte[]" Usage="udpClient.Receive remoteEP" /> ``` Changed the signature and the usage to the following: ``` xml <MemberSignature Language="F#" Value="member this.Receive : (remoteEP : IPEndPoint ref) -> byte[]" Usage="udpClient.Receive (ref remoteEP)" /> ``` However, I am not quite sure how correct this is. The 'Value' attribute is probably correct, but the 'Usage' attribute is suspect. One would not simply pass in `ref remoteEP` but rather something more like this: ``` fsharp let remoteEndPointRef = ref (IPEndPoint (IPAddress.Any, 0)) let bytes = udpClient.Receive remoteEndPointRef printfn "Received from %A: %A" !remoteEndPointRef bytes ``` Finally, there is no F# example code. I should love to submit an F# version of the C# sample, but it is not at all clear to me how to add it! The C# code sample is apparently an include of some sort: ``` [!code-csharp[Classic UdpClient.PublicMethodsAndPropertiesExample#11](~/samples/snippets/csharp/VS_Snippets_Remoting/Classic UdpClient.PublicMethodsAndPropertiesExample/CS/source.cs#11)] ``` Is there a way to do something similar to include an F# sample?
|
Thanks for raising this issue, @bradleyscollins. The <MemberSignature> sections are created using reflection, which also means that any authored modification will be overwritten by the next reflection. @dend, @joelmartinez, and @cartermp, could you take a look? |
rpetrusha
added
the
waiting-on-feedback
|
Yeah, this is the correct signature. Unfortunately, the code generator that uses this is not a proper syntax-based code formatter and thus has multiple errors for F#. I'd like to take this, but I don't want the signature to get wiped again. |
|
@cartermp I'm still planning on revisiting this PR: Does this batch of changes include a fix for this particular issue? |
|
What should we do here? Next reflection run would erase this. Do we need a new issue or the existing work being done for F# already captures this @cartermp and @joelmartinez? |
mairaw
added
the
blocked
|
@cartermp can you comment? |
|
I just happened to speak with @mimisasouvanh about this issue yesterday, so from a PM/tracking perspective hopefully she can chime in as far as completing that PR :) |
|
Reaching out to @cartermp to confirm whether the changes in PR#332 includes a fix for this or not. If not, I'll create a customer suggestion to track internally. |
|
ping @cartermp I think this is fixed with the latest mdoc release. Can you confirm? |
|
Is the new mdoc release live? |
|
@cartermp yes it's live. I don't know if it's relevant/related, but there's still this PR out there that I'd like to complete at some point: |
|
In that case this is not fixed - the name of the parameter is missing and the type is incorrect. |
|
@cartermp do you know if this particular issue was fixed in that PR? |
|
Sorry for the delay here - no, I don;'t think that PR fixes the issue reported here |
|
@mimisasouvanh Did/can you create a customer suggestion to track this? |
|
@joelmartinez @mimisasouvanh - Do you have any updates for this PR? |
|
We have an internal bug to track this. Thanks @carlossanlop for bringing this back up so it doesn't slip through the cracks! cc @joelmartinez |
|
Adding @KathleenDollard The internal work item is closed, but I believe it was closed without action. Can you check if this is fixed? |
Summary
The
Receivemethod's F# signature was incorrect—the remoteEP parameter was missing:Changed the signature and the usage to the following:
However, I am not quite sure how correct this is. The 'Value' attribute is probably correct, but the 'Usage' attribute is suspect. One would not simply pass in
ref remoteEPbut rather something more like this:Fixes [none]