search

gftea / amqprs

Async & Lock-free RabbitMQ Rust Client, Easy-to-use API
MIT License
217 stars 27 forks source link

AMQP reference documentation was moved to github #153

Open qrilka opened 5 days ago

qrilka commented 5 days ago

AMQP 0.9.1 reference documentation was moved from www.rabbitmq.com to https://github.com/rabbitmq/amqp-0.9.1-spec/blob/b8e975a762b8677263ebbbba1e70654b5263af81/docs/amqp-0-9-1-reference.md But the rustdocs point to the old URL, e.g. see https://github.com/gftea/amqprs/blob/e9c419fbffe39d92d7f8a841bb853f45181ec45a/amqprs/src/api/channel/basic.rs#L342

michaelklishin commented 5 days ago

I would suggest not linking to the reference. Most users don't care.

If you have to link to a document, you might as well choose https://www.rabbitmq.com/amqp-0-9-1-quickref which is not formatted any better than the document on GitHub but is shorter and covers enough for a curious user.

michaelklishin commented 5 days ago

If you really want to link to the protocol method reference document, https://github.com/rabbitmq/amqp-0.9.1-spec/blob/main/pdf/amqp-xml-doc0-9-1.pdf might be the best option because it is decently formatted.