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

[BUG] Outdated code examples in README #568

Closed
1 task
drknzz opened this issue Dec 6, 2022 · 4 comments · Fixed by #569
Closed
1 task

[BUG] Outdated code examples in README #568

drknzz opened this issue Dec 6, 2022 · 4 comments · Fixed by #569
Assignees
Labels
bug Something isn't working

Comments

@drknzz
Copy link
Member

drknzz commented Dec 6, 2022

What happened

The code examples in readme, showing the use of async and sync api:

  • create Client instance which is now an abstract class
  • do not use an account, making invoke throw an error

Probably the best solution would be to use only call and call_sync in the examples as they don't require an account.

Stack trace

Steps to reproduce

SDK Version

0.11.0-alpha

Python version

3.8.4

What operating system are you using?

Mac

Is there an existing issue for this?

  • I have searched the existing issues and verified no issue exits for this problem.
@drknzz drknzz added the bug Something isn't working label Dec 6, 2022
@cptartur
Copy link
Member

cptartur commented Dec 6, 2022

Where exactly this problem exists? We should probably fix it soon.

@drknzz
Copy link
Member Author

drknzz commented Dec 6, 2022

There are only 2 examples in readme.

@drknzz
Copy link
Member Author

drknzz commented Dec 6, 2022

I think code examples from readme should always work after a user copy pastes them into their ide. It should be somewhat of a check that the library has been installed successfully. For any further uses, they should go to the documentation web page.
Therefore we probably shouldn't be using an account there - just a pure GatewayClient and a method call.

@cptartur
Copy link
Member

cptartur commented Dec 6, 2022

I see your point. We can do some improvements to readme.

@cptartur cptartur self-assigned this Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants