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

Code documentation for most of IDiagnosticEvents et al #3454

Merged

Conversation

petli
Copy link
Contributor

@petli petli commented Apr 8, 2021

Summary of the changes (Less than 80 chars)

  • Documented most of IDiagnosticEvents (skipped methods where I wasn't sure exactly what they do)
  • Documented IDiagnosticEventsListener
  • Documented DiagnosticEventsListener

No related issue.

@petli
Copy link
Contributor Author

petli commented Apr 8, 2021

After digging through the code to find out how to use these interfaces in my code it seemed a waste not to also write down what I learned and submit it :)

@michaelstaib
Copy link
Member

Awesome!

@michaelstaib michaelstaib requested a review from PascalSenn April 8, 2021 15:46
@michaelstaib michaelstaib added this to the HC-11.2.0 milestone Apr 8, 2021
@michaelstaib michaelstaib added 🌶 hot chocolate 📚 documentation This issue is about working on our documentation. labels Apr 8, 2021
petli and others added 4 commits April 9, 2021 11:47
I'm not sure what an IExecutionTask really is, but it is worthwhile pointing out the dependency on
IDiagnosticEventListener.EnableResolveFieldValue.
@michaelstaib
Copy link
Member

/AzurePipelines run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@michaelstaib
Copy link
Member

I chipped in some more documentation about the request context and the missing instrumentation events. Thanks so much for your work on this!

@michaelstaib michaelstaib merged commit e90190e into ChilliCream:main Apr 9, 2021
@sonarcloud
Copy link

sonarcloud bot commented Apr 9, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@petli petli deleted the IDiagnosticsEvent-code-documentation branch April 9, 2021 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation This issue is about working on our documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants