getsentry / getsentry/sentry-dotnet

docs: Improve documentation around "Status" of `CaptureFeedback`

Open
#5,289 1 comment 0 reactions 0 assignees View on GitHub
.NET Docs Documentation Product: User Feedback User Feedback User Feedbacks
Dominant language
C#
Stars
770
Forks
248
Avg merge
3d 4h
Merged PRs (30d)
49

Description

### Summary

Improve `sentry-docs` and C# XML Documentation Comments of overloads of public `CaptureFeedback` with `out CaptureFeedbackResult` in parameter list.

### Remarks

In #4613 we changed `CaptureFeedback` to also return "status"/"result" information of the invoked API.
But getsentry/sentry-unity#2715 shows that there can be a confusion about what `CaptureFeedbackResult.Success` means.
We can improve our documentation and XML comments to be a bit more clear that this means successful validation of the input, and that no event processors has prevented the envelope from being handed off to the `IBackgroundWorker` nor being sent via the `ITransport`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.