Skip to content

fix: Deeply simplify the examples#319

Merged
viveknair merged 2 commits intonextfrom
vivek/fix-examples
Jun 20, 2025
Merged

fix: Deeply simplify the examples#319
viveknair merged 2 commits intonextfrom
vivek/fix-examples

Conversation

@viveknair
Copy link
Copy Markdown
Contributor

@viveknair viveknair commented Jun 19, 2025

TLDR

Reformats Python code examples in README for better readability and consistency

Summary

This PR simplifies and standardizes the code formatting in the README.md file's Python examples. The changes focus on improving code readability by adding proper spacing between function definitions and ensuring consistent formatting throughout all code examples.

Key Changes

  • Added blank lines between function definitions for better visual separation
  • Reformatted inline code to improve readability (e.g., OpenAI chat completion calls)
  • Ensured consistent spacing after decorators (@interaction, @traced, @eval)
  • Maintained consistent formatting style across all code examples

Impact

  • README.md documentation only
  • No functional code changes
  • Affects all Python code examples in the getting started and usage sections

Testing Considerations

  • Verify that all code examples remain syntactically correct
  • Ensure formatting changes don't break any copy-paste functionality for users
  • Check that the examples still render properly in markdown viewers

@viveknair viveknair requested a review from joshlebed June 19, 2025 13:33
@viveknair viveknair merged commit eea245f into next Jun 20, 2025
10 checks passed
@stainless-app stainless-app bot mentioned this pull request Jun 20, 2025
viveknair pushed a commit that referenced this pull request Jun 25, 2025
* fix: Deeply simplify the examples (#319)

* fix: Deeply simplify the examples

* chore: Refactor test setup in lib init module

* release: 1.0.0-alpha.6

---------

Co-authored-by: Vivek Nair <vivek@gentrace.ai>
Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.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