Add examples to docstrings for consumer methods #182
Conversation
Adarsh-jaiss
requested review from
idanasulin2706 and
rnowling-memphis
as code owners
rnowling-memphis
left a comment
rnowling-memphis
left a comment
There was a problem hiding this comment.
Really nice work @Adarsh-jaiss ! It's very clear and well formatted. Thank you! Some small changes.
memphis/consumer.py
Outdated
| await asyncio.sleep(1) | ||
| asyncio.run(main()) | ||
There was a problem hiding this comment.
Remove the blank lines
memphis/consumer.py
Outdated
| await memphis.connect(host='localhost', username='user', password='pass') | ||
| consumer = await memphis.consumer(station_name='my_station', consumer_name='my_consumer', consumer_group='my_group') | ||
| consumer.set_context({'key': 'value'}) | ||
| consumer.consume(callback=message_handler) |
There was a problem hiding this comment.
Can parameters be passed by name if they are not specified by keyword arguments? Might be safer to remove callback=.
There was a problem hiding this comment.
Ah, I see how I stated that could be confusing. I meant change it to this:
consumer = await memphis.consumer(station_name='my_station', consumer_name='my_consumer', consumer_group='my_group')
consumer.set_context({'key': 'value'})
consumer.consume(message_handler)- removed the first line and blank lines - Used the named parameters
rnowling-memphis
left a comment
rnowling-memphis
left a comment
There was a problem hiding this comment.
@Adarsh-jaiss small miscommunication on my end -- I wasn't clear in my feedback. Sorry about that. Please see my note. Thanks!
memphis/consumer.py
Outdated
| await memphis.connect(host='localhost', username='user', password='pass') | ||
| consumer = await memphis.consumer(station_name='my_station', consumer_name='my_consumer', consumer_group='my_group') | ||
| consumer.set_context({'key': 'value'}) | ||
| consumer.consume(callback=message_handler) |
There was a problem hiding this comment.
Ah, I see how I stated that could be confusing. I meant change it to this:
consumer = await memphis.consumer(station_name='my_station', consumer_name='my_consumer', consumer_group='my_group')
consumer.set_context({'key': 'value'})
consumer.consume(message_handler)
rnowling-memphis
left a comment
rnowling-memphis
left a comment
There was a problem hiding this comment.
Nice work @Adarsh-jaiss
2 participants
The method
Consumer.fetch()has an example of how to use the method in its docstring. I have added a similar example to the docstring for Consumer.consume().Closed Issue Add examples to docstrings for consumer methods #181