Add examples to docstrings for consumer methods

[rnowling-memphis]

Add examples to docstrings for consumer methods

[rnowling-memphis]

@Adarsh-jaiss are you interested in this?

[Adarsh-jaiss]

• yeah I would love to work on this!
• could you please explain me a bit about the issue?

[rnowling-memphis]

Please compare the docstrings (function documentation) for the two functions I put links to. One of them has a nice example of how to call the function, while the other does not :)

[Adarsh-jaiss]

Will it work, kindly review this :

def consume(self, callback):
    """
    Consume events.

    This method starts consuming events from the specified station and invokes the provided callback function for each batch of messages received.

    Parameters:
        callback (function): A function that will be called with each batch of messages received. The function should have the following signature:
            - `callback(messages: List[Message], error: Optional[MemphisError], context: Dict) -> Awaitable[None]`
            - `messages`: A list of `Message` objects representing the batch of messages received.
            - `error`: An optional `MemphisError` object if there was an error while consuming the messages.
            - `context`: A dictionary representing the context that was set using the `set_context()` method.

    Example:
        import asyncio
        from memphis import Memphis

        async def message_handler(messages, error, context):
            if error:
                print(f"Error occurred: {error}")
                return

            for message in messages:
                print(f"Received message: {message}")

        async def main():
            memphis = Memphis()
            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)

            # Keep the event loop running
            while True:
                await asyncio.sleep(1)

        asyncio.run(main())
    """

self.dls_callback_func = callback
self.t_consume = asyncio.create_task(self.__consume(callback))

[rnowling-memphis]

@Adarsh-jaiss It's nearly impossible to review and comment on an issue -- can you create a PR? I think going forward, it would be best just to go directly to creating a PR if you want feedback on code. Thanks!

[rnowling-memphis]

Closed by #182