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

Minor: Document expected result of ddog_prof_Profile_add #87

Merged
merged 1 commit into from
Jan 16, 2023

Commits on Jan 13, 2023

  1. Minor: Document expected result of ddog_prof_Profile_add

    **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 committed Jan 13, 2023
    Configuration menu
    Copy the full SHA
    53ffb4f View commit details
    Browse the repository at this point in the history