search

GetStream / stream-python

Python Client - Build Activity Feeds & Streams with GetStream.io
https://getstream.io
BSD 3-Clause "New" or "Revised" License
142 stars 40 forks source link

SDK has extra unused parameter for fetching feeds I follow #55

Closed iandouglas closed 6 years ago

iandouglas commented 7 years ago

Problem explanation

Our documentation at Stream advises Python users to fetch a list of feeds a user follows by calling the .following() method with a parameter to pass in a list of feeds to filter by, but also includes a filter parameter which goes unused. Our documentation will be updated, but perhaps this unused parameter should be removed from the SDK as well? Since this could potentially cause a breaking change for our SDK users, perhaps we should also bump the minor version from 2.3 to 2.4.

Code snippet that causes the problem

https://github.com/GetStream/stream-python/blob/1d9b95ae38dce1991028e102c572889d697c3685/stream/feed.py#L184

iandouglas commented 7 years ago

For clarification, our other SDKs use a parameter called filter for this SDK call, instead of feeds so I would suggest we drop the feeds parameter instead and use the filter parameter to maintain continuity across our libraries.