Documentation Issue

[bamsutler]

It's not an issue with the repo, but I don't see another place to report it.

The official documentation has the on message function structured like this in a number of places on the linked page:

from coinbase.rest import WSClient

api_key = "organizations/{org_id}/apiKeys/{key_id}"
api_secret = "-----BEGIN EC PRIVATE KEY-----\nYOUR PRIVATE KEY\n-----END EC PRIVATE KEY-----\n"

def on_message(ws, message):
    print(message)

ws_client = WSClient(api_key=api_key, api_secret=api_secret, on_message=on_message, verbose=True)

The readme in this repo has the following correct code:

from coinbase.websocket import WSClient

api_key = "organizations/{org_id}/apiKeys/{key_id}"
api_secret = "-----BEGIN EC PRIVATE KEY-----\nYOUR PRIVATE KEY\n-----END EC PRIVATE KEY-----\n"

def on_message(msg):
    print(msg)

client = WSClient(api_key=api_key, api_secret=api_secret, on_message=on_message)

[github-actions]

Thank you for reporting! If this is an SDK specific issue, we will look into it and get back to you soon. If this is an API related request, report it in our Advanced API forum instead.

[justinsogoni-cb]

Thanks! We noted this and will make it consistent in the near future

[urischwartz-cb]

@bamsutler this is fixed now. Thanks again for reporting!

[bamsutler]

Thank you ! Appreciate the hard work on these tools 👍