Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the README.md by restricting the supported OS list to Linux, removing an unnecessary JSON requirement from a code example, and updating a class reference. Feedback indicates that the OS restriction might be misleading if the SDK remains compatible with other platforms, and the change from ResolutionDetails to EvaluationDetails appears to introduce a documentation inaccuracy as it contradicts the existing implementation and tests.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #274 +/- ##
=======================================
Coverage 99.50% 99.50%
=======================================
Files 31 31
Lines 808 808
=======================================
Hits 804 804
Misses 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s README to better reflect current behavior and terminology in the Ruby SDK.
Changes:
- Update the requirements table OS column to reflect Linux-only CI verification.
- Remove an unused
require 'json'line from the quick start snippet. - Update the detailed-evaluation comment to reference
EvaluationDetailsinstead ofResolutionDetails.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2b4d4f5 to
b645a84
Compare
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
b645a84 to
80fc4d3
Compare
Summary
Changes
require 'json' # For JSON.dumpline. The comment claims it's forJSON.dump, but noJSON.dump(or any otherJSONmethod) is called anywhere in the quick start code block# see ResolutionDetails for more infotoEvaluationDetails. Thefetch_*_detailsmethods return anEvaluationDetailsinstance (which wraps aResolutionDetailsinternally), not aResolutionDetailsdirectly