Skip to content

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

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

Open
Nezteb opened this issue Mar 13, 2025 · 1 comment
Open

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

Nezteb opened this issue Mar 13, 2025 · 1 comment
Labels

Comments

@Nezteb
Copy link

Nezteb commented Mar 13, 2025

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

@Nezteb Nezteb added the bug label Mar 13, 2025
@Nezteb
Copy link
Author

Nezteb commented Mar 13, 2025

Actually I'm guessing these docs are for: https://github.com/rabbitmq/rabbitmq-amqp1.0-client

The hex.pm page links to the correct code, but the old documentation:

Image

@Nezteb Nezteb changed the title Republish amqp10_client documentation on hexdocs.pm Republish amqp10_client documentation on hex.pm/hexdocs.pm Mar 13, 2025
@michaelklishin michaelklishin changed the title Republish amqp10_client documentation on hex.pm/hexdocs.pm Erlang AMQP 1.0 client docs on hexdocs.pm are out of date Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant