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

links for otp apps' (gen_tcp/ssl) types use old format #1907

Closed
ruslandoga opened this issue May 29, 2024 · 4 comments · Fixed by #1908
Closed

links for otp apps' (gen_tcp/ssl) types use old format #1907

ruslandoga opened this issue May 29, 2024 · 4 comments · Fixed by #1908

Comments

@ruslandoga
Copy link
Contributor

ruslandoga commented May 29, 2024

👋

Docs for a type like

@type socket :: :gen_tcp.socket() | :ssl.sslsocket()

generate incorrect links to the new Erlang docs.

Generated:

Should be:

Example: https://hexdocs.pm/mua/Mua.html#t:socket/0

Mua's ExDoc is at v0.33.0: https://github.com/ruslandoga/mua/blob/73122aef37ce098e125c5e921e100bcdf61d19ef/mix.lock#L6

@ruslandoga ruslandoga changed the title otp app type links are incorrect otp app (gen_tcp/ssl) type links are incorrect May 29, 2024
@ruslandoga ruslandoga changed the title otp app (gen_tcp/ssl) type links are incorrect otp app (gen_tcp/ssl) type links use old format May 29, 2024
@ruslandoga ruslandoga changed the title otp app (gen_tcp/ssl) type links use old format links for otp apps' (gen_tcp/ssl) types use old format May 29, 2024
@josevalim
Copy link
Member

YEs, we need to update to the new docs. Can you please send a PR? I think it is now much more standardized, so it should be a matter of sharing code with the existing ExDoc logic but just change the URL.

@ruslandoga
Copy link
Contributor Author

👋 @josevalim

Sure, I will!

@ruslandoga
Copy link
Contributor Author

PR: #1908

@josevalim
Copy link
Member

Closing in favor of the PR.

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

Successfully merging a pull request may close this issue.

2 participants