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

Add docs and fix rate limiting for websockets of dYdX #1999

Merged
merged 3 commits into from
Oct 12, 2024

Conversation

davidsblom
Copy link
Collaborator

Pull Request

Add docs and fix rate limiting for websockets of dYdX

Type of change

Delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How has this change been tested?

Live example

Returns
-------
bool
Whether the client is already subscribed to this topic.
Copy link
Member

Choose a reason for hiding this comment

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

I think it's best to add only additional info relative to the return type for the description, in this case it's been covered in the main description already.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Makes sense. Thanks!

----------
raw : bytes
The received message in bytes.
"""
Copy link
Member

Choose a reason for hiding this comment

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

Small point, but we tend to leave a single blank line at the end of the docstring. The docformatter lint may just handle this when its turned back on.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for formatting the code already.

@cjdsellers
Copy link
Member

Thanks @davidsblom 🙏

@cjdsellers cjdsellers merged commit 33f5a2a into develop Oct 12, 2024
10 checks passed
@cjdsellers cjdsellers deleted the dydx-rate-limiting branch October 12, 2024 19:43
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