Skip to content

Show <returns> and <value> documentation in Quick Info#42128

Merged
sharwell merged 2 commits intodotnet:masterfrom
sharwell:show-returns
Mar 3, 2020
Merged

Show <returns> and <value> documentation in Quick Info#42128
sharwell merged 2 commits intodotnet:masterfrom
sharwell:show-returns

Conversation

@sharwell
Copy link
Copy Markdown
Contributor

@sharwell sharwell commented Mar 3, 2020

image

image

image

image

@sharwell sharwell requested a review from a team as a code owner March 3, 2020 05:47
Comment thread src/Features/Core/Portable/QuickInfo/CommonSemanticQuickInfoProvider.cs Outdated
Comment thread src/Features/Core/Portable/QuickInfo/CommonSemanticQuickInfoProvider.cs Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

only for methods? not for props?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Typically <returns> is expected to be used for methods and <value> is expected to be used for properties. The most common case where they are mixed up involves <returns> being used for properties. However, since there is no explicit limitation to placement in the language, this pull request supports both elements on both methods and properties.

Copy link
Copy Markdown
Contributor

@CyrusNajmabadi CyrusNajmabadi left a comment

Choose a reason for hiding this comment

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

Nice!

@sharwell sharwell merged commit b28f5fe into dotnet:master Mar 3, 2020
@sharwell sharwell deleted the show-returns branch March 3, 2020 21:52
@sharwell sharwell added this to the 16.6.P2 milestone Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants