Spec for turtle's public APIs

jlouis / turtle

A wrapper on the RabbitMQ Erlang Client (Erlang)

Other

71 stars 15 forks source link

Spec for turtle's public APIs #5

Closed sdebnath closed 8 years ago

sdebnath commented 8 years ago

Currently, only declare/2 and open_channel/1 is spec'ed.

Need specs for:

publish/5,
publish/6,
publish_sync/5,
publish_sync/6,
rpc/5,
rpc_await/3,
rpc_await_monitor/3,
rpc_cancel/2,
rpc_sync/5,
rpc_sync/6
consume/2,
cancel/2,
qos/2

jlouis commented 8 years ago

We can probably skip consume/2, cancel/2 and qos/2 because they are all private functions for internal use. In fact, one might consider moving them out of the turtle module. The remaining could use specs though.

jlouis commented 8 years ago

This should be done in commit 162fec4c6ba249b3393325e which includes specifications for the necessary functions. I've also moved the @private marked functions into their own section in the source code.

jlouis commented 8 years ago

This has been done.