Improve ProfileExporter API docs #59
Merged
Conversation
This file contains 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
After some discussion on the expected values for `profiling_library_name` on slack, I've decided to go ahead and document the current expectations alongside the API.
pawelchcki
approved these changes
Oct 12, 2022
morrisonlevi
approved these changes
Oct 12, 2022
|
Thanks y'all! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
After some discussion on the expected values for
profiling_library_nameon slack, I've decided to go ahead and document the current expectations alongside the API.Motivation
Avoid confusion over expected values for
profiling_library_name.Additional Notes
(None)
How to test the change?
(This is a documentation change only)