On the fly docs - add telemetry regarding documentation comments #74088
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
added
Area-IDE
untriaged
genlu
reviewed
Jun 21, 2024
| throw new InvalidOperationException("QuickInfoSession is null"); | ||
| } | ||
|
|
||
| OnTheFlyDocsLogger.LogShowedOnTheFlyDocsLink(); |
Member
There was a problem hiding this comment.
Could we log whether a symbol has doc-comment here? That would tell us how often a symbol user hover over has no doc, right?
genlu
reviewed
Jun 21, 2024
| /// <param name="language">the language of the symbol</param> | ||
| internal sealed class OnTheFlyDocsElement(string symbolSignature, ImmutableArray<string> declarationCode, string language) | ||
| /// <param name="hasComments">whether the symbol has comments</param> | ||
| internal sealed class OnTheFlyDocsElement(string symbolSignature, ImmutableArray<string> declarationCode, string language, bool hasComments) |
Member
There was a problem hiding this comment.
Maybe also differentiate source symbols and metadata symbols?
genlu
reviewed
Jun 21, 2024
| Logger.Log(FunctionId.CodeAnalysisService_CalculateDiagnosticsAsync, KeyValueLogMessage.Create(m => | ||
| { | ||
| m["SymbolHeaderText"] = _onTheFlyDocsElement.SymbolSignature; | ||
| }, LogLevel.Information)); |
Member
Author
There was a problem hiding this comment.
Oh I meant to change that
genlu
reviewed
Jun 21, 2024
| return new OnTheFlyDocsElement(symbol.ToDisplayString(), symbolStrings, symbol.Language); | ||
| return new OnTheFlyDocsElement(symbol.ToDisplayString(), symbolStrings, symbol.Language, hasDocumentationComment); | ||
|
|
||
| bool HasDocumentationComment(ImmutableArray<SyntaxReference> references) |
Member
There was a problem hiding this comment.
when creating a tooltip in QuickInfoUtilities.CreateQuickInfoItemAsync, it looks like we know whether if contains doc-comment, is it possible log there instead so we don't have to check the syntax?
genlu
reviewed
Jun 21, 2024
| return null; | ||
| } | ||
|
|
||
| if (symbol.MetadataToken != 0) |
Member
There was a problem hiding this comment.
so this does what we want? Great!
genlu
approved these changes
Jun 21, 2024
333fred
added a commit
to 333fred/roslyn
that referenced
this pull request
Jun 24, 2024
* upstream/main: [main] Update dependencies from dotnet/arcade (dotnet#74099) Remove warning for `yield return` in `lock` (dotnet#74024) [release/dev17.10] Update dependencies from dotnet/arcade (dotnet#74113) On the fly docs - add telemetry regarding documentation comments (dotnet#74088) Query for the COM service provider instead of direct cast Add type hints for collection expressions (dotnet#74051) Align implementation with latest LDM decisions around invocations in presence of dynamic arguments. (dotnet#74097) Avoid allocations in AbstractSyntaxIndex<>.GetIndexAsync
This was referenced Jun 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds some telemetry to see if documentation comments impact the number of users clicking "tell me more" link.