Skip to content

Conversation

@ijklam
Copy link
Contributor

@ijklam ijklam commented Dec 9, 2023

Description

Make remarks and returns parts of xml documentation visible in quick info.
And fix a bug that no xml doc was showed when let ok, idx = index.ParseMemberSignature return ok = 0, idx = 0

Showing returns parts can let user know more about to the function's return value (especially when it returns named tuples from C#)
图片
图片

Showing remarks parts can let user know more about to the function
图片
图片

Checklist

  • Test cases added

  • Performance benchmarks added in case of performance changes

  • Release notes entry updated:

    Please make sure to add an entry with short succint description of the change as well as link to this pull request to the respective release notes file, if applicable.

    Release notes files:

    • If anything under src/Compiler has been changed, please make sure to make an entry in docs/release-notes/FSharp.Compiler.Service/<version>.md, where <version> is usually "highest" one, e.g. 42.8.200
    • If language feature was added (i.e. LanguageFeatures.fsi was changed), please add it to docs/releae-notes/Language/preview.md
    • If a change to FSharp.Core was made, please make sure to edit docs/release-notes/FSharp.Core/<version>.md where version is "highest" one, e.g. 8.0.200.

    Examples of release notes entries:

    If you believe that release notes are not necessary for this PR, please add NO_RELEASE_NOTES label to the pull request.

@ijklam ijklam requested a review from a team as a code owner December 9, 2023 13:14
@ijklam
Copy link
Contributor Author

ijklam commented Dec 9, 2023

@dotnet-policy-service agree

add an option to control visibility of `remarks`
@ijklam
Copy link
Contributor Author

ijklam commented Dec 10, 2023

new line was added adds between sections, and remarks now is after the returns
图片

an new options was added to control visibility of remarks
图片

Copy link
Contributor

@psfinaki psfinaki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a bunch for this. And great to see that someone is testing VS localization :)

@majocha @brianrourkeboll @baronfel thanks for your inputs here as well!

@psfinaki psfinaki enabled auto-merge (squash) December 11, 2023 11:57
@psfinaki psfinaki merged commit 863d691 into dotnet:main Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants