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

Radheem/quant 564 fix firefly python client documentation #68

Merged

Conversation

radheem
Copy link
Contributor

@radheem radheem commented May 2, 2023

Description

This PR smooths the user onboarding process by improving examples and comments.

Change Log

  1. Simplified the main event loop
  2. Orderbook updates were used to illustrate socket connection in most examples. Since most users test on the Testnet and Testnet Orderbooks don’t update frequently, the user won’t always get events, and the example will not be able to illustrate the flow successfully. Hence moved all socket illustrations to exchange health events
  3. Replaced code snippets in readme with complete functioning examples.
  4. The Sockets.open() function call Sockets._establish_connection() function, then checks if the connection was established; if it failed to create a connection it then calls Sockets.close(), which is an async function, but this call had no await so added await.
  5. removed unnecessary semicolons

LINKS

QUANT-564

Copy link
Contributor

@yasir7ca yasir7ca left a comment

Choose a reason for hiding this comment

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

Good job

@radheem radheem merged commit 18a83ed into main May 4, 2023
@radheem radheem deleted the radheem/quant-564-fix-firefly-python-client-documentation branch May 4, 2023 09:09
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