Minor: Document expected result of ddog_prof_Profile_add
#87
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
**What does this PR do?**: Documents the expected result of the `ddog_prof_Profile_add` API. **Motivation**: While validating #80 on Ruby, I called `add` in a way that should've triggered an error, but saw none. On closer inspection, I had no error handling for `add` because it wasn't clear to me that its result could indicate an error. Thus, I decided to document that fact. **Additional Notes**: At some point we could change `add` to return an actual result, allowing us to pass the error message back to the caller, but for now I decided to just document it. **How to test the change?**: Documentation change only.
ivoanjo
added a commit
to DataDog/dd-trace-rb
that referenced
this pull request
Jan 13, 2023
This will allow us to have early warning for when we're using the API incorrectly. See also DataDog/libdatadog#87 .
morrisonlevi
approved these changes
Jan 13, 2023
ivoanjo
added a commit
to DataDog/dd-trace-rb
that referenced
this pull request
Feb 3, 2023
This will allow us to have early warning for when we're using the API incorrectly. See also DataDog/libdatadog#87 .
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?:
Documents the expected result of the
ddog_prof_Profile_addAPI.Motivation:
While validating #80 on Ruby, I called
addin a way that should've triggered an error, but saw none.On closer inspection, I had no error handling for
addbecause it wasn't clear to me that its result could indicate an error.Thus, I decided to document that fact.
Additional Notes:
At some point we could change
addto return an actual result, allowing us to pass the error message back to the caller, but for now I decided to just document it.How to test the change?:
Documentation change only.