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

Doc fix for RecordException #5143

Merged

Conversation

cijothomas
Copy link
Member

@cijothomas cijothomas commented Dec 7, 2023

Fixes #1569

Given we were using ToString() from the 1st stable release, documenting that ex.ToString() is the chosen representation of stacktrace. #1569 has question about using ToString() vs StackTrace, but given this is already part of stable release, we need to keep this behavior.

It is okay to provide an option to customize this, if there is demand, or change the chosen representation in v2.0. This PR is just documenting the existing behavior.

Merge requirement checklist

  • CONTRIBUTING guidelines followed (nullable enabled, static analysis, etc.)
  • Unit tests added/updated
  • Appropriate CHANGELOG.md files updated for non-trivial changes
  • Changes in public API reviewed (if applicable)

@cijothomas cijothomas requested a review from a team December 7, 2023 19:30
Copy link

codecov bot commented Dec 7, 2023

Codecov Report

Merging #5143 (1074390) into main (58e8f24) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #5143   +/-   ##
=======================================
  Coverage   83.29%   83.29%           
=======================================
  Files         297      297           
  Lines       12380    12380           
=======================================
  Hits        10312    10312           
  Misses       2068     2068           
Flag Coverage Δ
unittests 83.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
src/OpenTelemetry.Api/Trace/ActivityExtensions.cs 95.45% <ø> (ø)

... and 8 files with indirect coverage changes

@utpilla utpilla merged commit 93fd7d3 into open-telemetry:main Dec 8, 2023
40 checks passed
@cijothomas cijothomas deleted the cijothomas/activity-exception-doc-fix branch December 8, 2023 02:18
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.

.net definition for exception.stacktrace should be chosen and defined
3 participants