Skip to content

Conversation

@chrisjsimpson
Copy link

@chrisjsimpson chrisjsimpson commented Dec 7, 2025

Pull Request check-list

  • Do tests and lints pass with this change?
  • Do the CI tests pass with this change (enable it first in your forked repo and wait for the github action build to finish)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Is there an example added to the examples folder (if applicable)?

Description of change

[docs] Make readme examples copy/paste possible by removing >>> and dding # to preserve output to preserve meaning

…dding # to preserve output to preserve meaning

Signed-off-by: chrisjsimpson <[email protected]>
Copy link

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 improves the usability of README code examples by converting them from Python REPL format to plain executable Python code. The examples previously included >>> prompts which prevented direct copy/paste execution. By removing these prompts and converting output to comments, users can now copy examples directly into their code or Python files.

Key Changes:

  • Removed Python REPL >>> prompts from all code examples
  • Converted output lines to # comments to preserve expected results while maintaining executability

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

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.

1 participant