Skip to content

Show <remarks> documentation in Quick Info#42135

Merged
sharwell merged 1 commit intodotnet:masterfrom
sharwell:show-remarks
Mar 16, 2020
Merged

Show <remarks> documentation in Quick Info#42135
sharwell merged 1 commit intodotnet:masterfrom
sharwell:show-remarks

Conversation

@sharwell
Copy link
Copy Markdown
Contributor

@sharwell sharwell commented Mar 3, 2020

Builds on #42128

Originally I was more concerned that this would clutter the Quick Info presentation. However, I found that the core library does not include any <remarks> documentation (at least in mscorlib.xml). The presentation used in this pull request has <remarks> rendered exactly the same way as additional <para> elements within a <summary> section.

image

@sharwell
Copy link
Copy Markdown
Contributor Author

sharwell commented Mar 3, 2020

Here's a screenshot from a property with longer remarks. I cropped the right side because I'm on a very wide screen and it didn't wrap.

image

@sharwell sharwell marked this pull request as ready for review March 3, 2020 22:06
@sharwell sharwell requested a review from a team as a code owner March 3, 2020 22:06
@miloush
Copy link
Copy Markdown

miloush commented Mar 4, 2020

I wonder if the remarks section in the tooltip could be somehow indicated, either visually (font style/separator/indentation etc.), or maybe preferably just by saying "Remarks:".

@sharwell
Copy link
Copy Markdown
Contributor Author

sharwell commented Mar 4, 2020

@miloush For the examples I found, it seemed to hurt more than help. The paragraph separation seems to work well for these two cases:

  1. Users who treat the <summary> as either the first sentence of, or the "tl;dr" of the <remarks>
  2. Users who write longer <summary> text, but leave out <remarks> because it was never visible to anyone before

@sharwell sharwell added Area-IDE Need Design Review The end user experience design needs to be reviewed and approved. labels Mar 7, 2020
@tamlin-mike
Copy link
Copy Markdown

@sharwell

Users who write longer <summary> text, but leave out <remarks> because it was never visible to anyone before

Just wanted to chime in that this is the exact reason I have almost never used the remarks tag, even that I have really wanted to - the IDE has worthless lousy support for displaying documentation in pop-ups. Compare this with e.g. IntelliJ IDEA to see how I (and most likely the vast majority of developers) would have liked this to work.

TL;DR; Thanks for fixing up old crap.

@sharwell
Copy link
Copy Markdown
Contributor Author

Design review conclusion: This feature seems likely to work exactly as expected for users who want to use <remarks> elements, and doesn't show for other users.

@sharwell sharwell merged commit 8b380d2 into dotnet:master Mar 16, 2020
@ghost ghost added this to the Next milestone Mar 16, 2020
@sharwell sharwell modified the milestones: Next, 16.6.P2 Mar 16, 2020
@sharwell sharwell removed the Need Design Review The end user experience design needs to be reviewed and approved. label Mar 16, 2020
@vatsalyaagrawal
Copy link
Copy Markdown
Contributor

vatsalyaagrawal commented Mar 23, 2020

Design meeting notes:

  • Everyone onboard with the change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

7 participants