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

Fix documentation #23

Open
ju5t opened this issue May 20, 2021 · 1 comment
Open

Fix documentation #23

ju5t opened this issue May 20, 2021 · 1 comment

Comments

@ju5t
Copy link

ju5t commented May 20, 2021

The Python documentation is incorrect. It says:

from python_bitvavo_api.bitvavo import Bitvavo

bitvavo = Bitvavo('<APIKEY>', '<APISECRET>')
response = bitvavo.trades('BTC-EUR', {})
for item in response:
  print(item)

But Bitvavo expects a dictionary, not two separate parameters. Fixing the documentation is probably the easiest, although to be fair, the dictionary should go. It's much cleaner to use arguments.

In some cases kwargs are a good fit too, but arguments > kwargs > dictionaries.

@NostraDavid
Copy link

This has already been fixed :)

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

No branches or pull requests

2 participants