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

make remarks and returns visible in quick info #16417

Merged
merged 5 commits into from
Dec 11, 2023
Merged

Conversation

Tangent-90
Copy link
Contributor

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.

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

@dotnet-policy-service agree

add an option to control visibility of `remarks`
@Tangent-90
Copy link
Contributor Author

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
Member

@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
26 checks passed
OwnageIsMagic added a commit to OwnageIsMagic/fsharp that referenced this pull request Dec 21, 2023
* upstream/main: (166 commits)
  typo in foldBack summary (dotnet#16453)
  Fix for dotnet#83 (improve constraint error message) (dotnet#16304)
  Name resolution: resolve interfaces in expressions (dotnet#15660)
  AddExplicitReturnType refactoring (dotnet#16077)
  Disabling 2 tests: running for too long, causing CI timeouts
  Improve value restriction error message dotnet#1103 (dotnet#15877)
  Parens: Keep parens for non-identical infix operator pairs with same precedence (dotnet#16372)
  More release note entries (dotnet#16438)
  Using Ordinal is both faster and more correct as our intent is to do … (dotnet#16439)
  merge (dotnet#16427)
  Optimize empty string compares (dotnet#16435)
  Checker: recover on unresolved type in 'inherit' member (dotnet#16429)
  Release notes proposal (dotnet#16377)
  [main] Update dependencies from dotnet/source-build-reference-packages (dotnet#16411)
  Allow usage of [<TailCall>] with older FSharp.Core package versions (dotnet#16373)
  Parser: recover on unfinished 'as' patterns (dotnet#16404)
  Parens: Keep parens in method calls in dot-lambdas (dotnet#16395)
  Checker: check unfinished obj expression inside computations (dotnet#16413)
  Added default dotnet-tools + additional tasks to launch them (dotnet#16409)
  make `remarks` and `returns` visible in quick info (dotnet#16417)
  ...
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