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

expand on what is sentry_capture_minidump for #1157

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bruno-garcia
Copy link
Member

This has been causing confusion.
More API doc hopefully to help clarify things.

Copy link

Fails
🚫 Please consider adding a changelog entry for the next release.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

- expand on what is sentry_capture_minidump for ([#1157](https://github.com/getsentry/sentry-native/pull/1157))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description.

Generated by 🚫 dangerJS against 9a12672

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.61%. Comparing base (2577cfc) to head (9a12672).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1157      +/-   ##
==========================================
- Coverage   82.66%   82.61%   -0.06%     
==========================================
  Files          53       53              
  Lines        7954     7954              
  Branches     1246     1246              
==========================================
- Hits         6575     6571       -4     
- Misses       1266     1267       +1     
- Partials      113      116       +3     

Comment on lines +1408 to +1411
*
* You don't need this function if you're relying on Sentry to create the minidump.
* This is useful when you have a minidump captured through a different mechanism,
* and you want Sentry to ingest it.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, but I would add it as a Note: paragraph at the end of the inline comment. We do this with most meta descriptions in the header.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants