lapin
lapin copied to clipboard
Request for a more comprehensive documentation
Hello,
I've been using this repository and find it very useful. However, I've noticed that the documentation could be improved to better assist those not very familiar with Rabbitmq
Specifically, I believe the following areas could benefit from more detailed documentation:
- API Documentation: Detailed descriptions of the project's API, including examples of how to use different functions or methods. Most of the methods/functions have no descriptions of what the inputs are or what they do.
An example is the method to create a
Consumer
pub async fn basic_consume(
&self,
queue: &str,
consumer_tag: &str,
options: BasicConsumeOptions,
arguments: FieldTable,
) -> Result<Consumer> {
self.do_basic_consume(queue, consumer_tag, options, arguments, None)
.await
}
- Configuration Options: A comprehensive list of configuration options available, along with explanations of what each option does and how to set it.
Thank you