Skip to content

Erlang AMQP 1.0 client docs on hexdocs.pm are out of date #13517

Open
@Nezteb

Description

@Nezteb

Describe the bug

Unless I'm misunderstanding how the Erlang AMQP 1.0 client is published, it looks like the version of :amqp10_client that the documentation on hexdocs.pm currently describes is old: https://hexdocs.pm/amqp10_client/

Reproduction steps

View the :amqp10_client docs on hexdocs.pm. Notice that the documented functions are different from the actual source code.

Expected behavior

The docs should be up-to-date or allow version selection similar to other hexdocs.pm packages.

For example, the docs should show a detach_link/1 function but not detach/2.

Additional context

Example code:

%% @doc Detaches a link.
%% This is asynchronous and will notify completion of the attach request to the
%% caller using an amqp10_event of the following format:
%% {amqp10_event, {link, LinkRef, {detached, Why}}}
-spec detach_link(link_ref()) -> ok | {error, term()}.
detach_link(#link_ref{link_handle = Handle, session = Session}) ->
amqp10_client_session:detach(Session, Handle).

Example docs:

Image

I'm guessing the docs are coming from here: https://github.com/rabbitmq/rabbitmq-amqp1.0-client/blob/master/src/amqp10_client_session.erl#L178-L180

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions