Skip to content

docs: fix inaccuracies in README#274

Open
jonathannorris wants to merge 1 commit intomainfrom
fix/readme-accuracy
Open

docs: fix inaccuracies in README#274
jonathannorris wants to merge 1 commit intomainfrom
fix/readme-accuracy

Conversation

@jonathannorris
Copy link
Copy Markdown
Member

@jonathannorris jonathannorris commented Apr 20, 2026

Summary

  • Fix minor accuracy issues in the README

Changes

  1. Quick start: Removed unused require 'json' # For JSON.dump line. The comment claims it's for JSON.dump, but no JSON.dump (or any other JSON method) is called anywhere in the quick start code block
  2. fetch_boolean_details comment: Fixed # see ResolutionDetails for more info to EvaluationDetails. The fetch_*_details methods return an EvaluationDetails instance (which wraps a ResolutionDetails internally), not a ResolutionDetails directly

Copilot AI review requested due to automatic review settings April 20, 2026 19:25
@jonathannorris jonathannorris requested a review from a team as a code owner April 20, 2026 19:25
@jonathannorris jonathannorris requested review from a team and beeme1mr April 20, 2026 19:25
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread README.md Outdated
Comment thread README.md
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.50%. Comparing base (5ed5a71) to head (80fc4d3).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 EvaluationDetails instead of ResolutionDetails.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
@jonathannorris jonathannorris force-pushed the fix/readme-accuracy branch 2 times, most recently from 2b4d4f5 to b645a84 Compare April 21, 2026 18:51
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
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