docs: fix inaccuracies in README code examples and descriptions#129
docs: fix inaccuracies in README code examples and descriptions#129jonathannorris wants to merge 1 commit intomainfrom
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the README to reflect changes in version 0.3.0 of the OpenFeature Rust SDK, including increasing the minimum Rust version to 1.80.1 and updating API methods like create_client and add_hook. It also corrects asynchronous patterns in examples, such as awaiting the shutdown method and reordering .await calls in flag evaluations. A review comment identifies a missing .await in the get_int_value example, which is necessary for the code to execute correctly.
Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
jonathannorris
force-pushed
the
fix/readme-accuracy
branch
from
9521966 to
8f7b901
Compare
There was a problem hiding this comment.
Pull request overview
Updates README.md to correct Rust SDK documentation examples so they reflect the current public API and async behavior, aligning stated MSRV and example snippets with the crate’s actual implementation.
Changes:
- Updated the documented MSRV to
1.80.1to matchCargo.toml(rust-version). - Fixed README code examples to use the correct API/method names and correct async/await ordering.
- Refreshed stale references in examples (e.g., structured logging version) and corrected a hook trait parameter typo.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary