Request for a more comprehensive documentation

[korir248]

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

[Keruspe]

Yes, this should definitely be done. Note that the options for example are not all defined by the protocol, but rather by the implementation so it's hard to do a comprehensive list here, this one should be provided by the server somehow.

Are there specific areas for which documentation would be "more important"? Sure all documentation doesn't have the same priority