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

Inconsistency between documented argument name and client's kwargs #181

Open
surlyengineer opened this issue Dec 11, 2024 · 0 comments
Open

Comments

@surlyengineer
Copy link

In the create portion of the docs for python here , the creation example is given as:

channel = client.channel("messaging", "travel", custom_data=dict(members=["thierry"]))
channel.create("myuserid")

As written that'll throw a TypeError: StreamChat.channel() got an unexpected keyword argument 'custom_data'

This tracks with the definition of the channel interface here but conflicts with the client definition here

I believe this should be as easy as updating the docs to say:

channel = client.channel("messaging", "travel", data=dict(members=["thierry"]))
channel.create("myuserid")

Or restoring the kwarg name to custom_data in the client definition.

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

1 participant