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

Missing xml-comments in metadata for C# api #80

Open
viktorvan opened this issue Mar 3, 2019 · 6 comments
Open

Missing xml-comments in metadata for C# api #80

viktorvan opened this issue Mar 3, 2019 · 6 comments
Labels
bug Something isn't working

Comments

@viktorvan
Copy link
Collaborator

viktorvan commented Mar 3, 2019

Describe the bug
Missing xml-comments in metadata for the C# api

What area is it related to
SwedishPersonalIdentityNumber.TryParse and
SwedishPersonalIdentityNumber.TryParseInSpecificYear

To Reproduce
Steps to reproduce the behavior:
Try to view xml-comments for the above mentioned methods, for example by hovering on the method names.

In the source code the methods have xml-comments:

    /// <summary>
    /// Converts the string representation of the personal identity number to its <see cref="SwedishPersonalIdentityNumber"/> equivalent  and returns a value that indicates whether the conversion succeeded.
    /// </summary>
    /// <param name="s">A string representation of the Swedish personal identity number to parse.</param>
    /// <param name="parseResult">If valid, an instance of <see cref="SwedishPersonalIdentityNumber"/></param>
    static member TryParse((s : string), [<Out>] parseResult : SwedishPersonalIdentityNumberCSharp byref) =
        let pin = parse s
        match pin with
        | Error _ -> false
        | Ok pin ->
            parseResult <- (pin |> SwedishPersonalIdentityNumberCSharp)
            true

But if you look in the comments file ActiveLogin.Identity.Swedish.xml there are no entries for the two functions with out-parameters.

Expected behavior
The xml-comments should be displayed. But they are not.

Screenshots

NuGet package version
2.0.1

Runtime version
.net core 2.2.104

Additional context
Visual Studio Code 1.31.1

@viktorvan viktorvan added the bug Something isn't working label Mar 3, 2019
@viktorvan
Copy link
Collaborator Author

Can someone confirm if this works or not in Visual Studio?

@PeterOrneholm
Copy link
Collaborator

Can someone confirm if this works or not in Visual Studio?

I can confirm :/ Why is this?

image

@viktorvan
Copy link
Collaborator Author

viktorvan commented Mar 8, 2019

Some more information.
When cloning a fresh project and building I can see that the xml-comments are generated correctly in bin/debug/netstandard2.0/ActiveLogin.Identity.Swedish.xml.

I can get intellisense from within an F# project when using the "CSharp"-facade SwedishPersonalIdentityNumberCSharp.

But if I create a C#-project and reference ActiveLogin.Identity.Swedish I cannot get any intellisense for the TryParse-functions with out-parameters.

@viktorvan
Copy link
Collaborator Author

viktorvan commented Mar 8, 2019

I have reported this as a bug in visualfsharp.

dotnet/fsharp#6310

@PeterOrneholm
Copy link
Collaborator

Is this still an issue @viktorvan?

@viktorvan
Copy link
Collaborator Author

This issue is not yet fixed in the fsharp-compiler. I suggest we keep it open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants