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

Setup doctests #37

Open
oyeb opened this issue Dec 22, 2017 · 0 comments
Open

Setup doctests #37

oyeb opened this issue Dec 22, 2017 · 0 comments

Comments

@oyeb
Copy link
Contributor

oyeb commented Dec 22, 2017

doctests will help us catch any stale examples in the documentation, in case the examples break due to changes in code.

The following need to be resolved for doctests to work:

  1. The outputs also have to be written down in the documentation
  • Typical response objects are huge (will take up a lot of space).
  • Responses are unique and can't be tested against.
  1. Our examples invoke calls on the :payment_worker but there's no gateway configuration in the app.
  2. We might be able to mock the remotes during the doctests too, but I'm not sure how. Mocking is important because all doctests will fail otherwise, because the remote responses are unique each time and we can't write the responses down in the docs.
@pkrawat1 pkrawat1 added this to the Release 1.6.0 milestone Dec 23, 2017
@pkrawat1 pkrawat1 removed this from the Release 1.6.0 milestone Jan 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

No branches or pull requests

2 participants