Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request for a more comprehensive documentation #399

Open
korir248 opened this issue Apr 3, 2024 · 0 comments
Open

Request for a more comprehensive documentation #399

korir248 opened this issue Apr 3, 2024 · 0 comments

Comments

@korir248
Copy link

korir248 commented Apr 3, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant