Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaned up examples and added documentation #1470

Merged
merged 2 commits into from
Oct 10, 2024
Merged

Conversation

jar-stripe
Copy link
Contributor

Why?

In our recent SDK release we added a couple new examples along with a template to make it easy for us to create new examples. The names of the examples and the template were confusing and hard to understand and our documentation around examples was lacking. This PR fixes/clarifies the names and added comments to explain each new example.

What?

  • renamed new_example.rb to example_template.rb and added file comment template
  • renamed stripe_webhook_handler.rb to thinevent_webhook_handler.rb and added file comment describing the example
  • added comment to meter_event_stream.rb describing the example
  • updated examples README

Copy link
Contributor

@ramya-stripe ramya-stripe left a comment

Choose a reason for hiding this comment

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

The tests are failing..

@jar-stripe jar-stripe merged commit 79ebfa5 into master Oct 10, 2024
14 checks passed
@jar-stripe jar-stripe deleted the jar/clean-up-examples branch October 10, 2024 18:08
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