Use Hexdocs format in :otp anchors #1908
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ruslandoga
commented
May 29, 2024
|
|
||
| assert html =~ | ||
| ~s|-type</span> t() :: <a href=\"https://www.erlang.org/doc/man/erlang.html#type-atom\">atom</a>().| | ||
| ~s|-type</span> t() :: <a href=\"https://www.erlang.org/doc/man/erlang.html#t:atom/0\">atom</a>().| |
Contributor
Author
There was a problem hiding this comment.
|
|
||
| assert html =~ | ||
| ~s|-type</span> t2() :: #rec{k1 :: <a href=\"https://www.erlang.org/doc/man/uri_string.html#type-uri_string\">uri_string:uri_string</a>(), k2 :: <a href=\"https://www.erlang.org/doc/man/uri_string.html#type-uri_string\">uri_string:uri_string</a>() \| undefined}.| | ||
| ~s|-type</span> t2() :: #rec{k1 :: <a href=\"https://www.erlang.org/doc/man/uri_string.html#t:uri_string/0\">uri_string:uri_string</a>(), k2 :: <a href=\"https://www.erlang.org/doc/man/uri_string.html#t:uri_string/0\">uri_string:uri_string</a>() \| undefined}.| |
Contributor
Author
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
Should we update man links as well or is it OK to rely on www.erlang.org to always perform this redirect?
Member
There was a problem hiding this comment.
I would say let's go ahead and link to the new page! Especially as I assume it will be less code? But we can do it in a next PR. :)
| test "erlang stdlib function" do | ||
| assert autolink_doc("`:lists.all/2`") == | ||
| ~s|<a href="https://www.erlang.org/doc/man/lists.html#all-2"><code class="inline">:lists.all/2</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/lists.html#all/2"><code class="inline">:lists.all/2</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "erlang callback" do | ||
| assert autolink_doc("`c::gen_server.handle_call/3`") == | ||
| ~s|<a href="https://www.erlang.org/doc/man/gen_server.html#Module:handle_call-3"><code class="inline">:gen_server.handle_call/3</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/gen_server.html#c:handle_call/3"><code class="inline">:gen_server.handle_call/3</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "erlang type" do | ||
| assert autolink_doc("`t::array.array/0`") == | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#type-array"><code class="inline">:array.array/0</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#t:array/0"><code class="inline">:array.array/0</code></a>| |
Contributor
Author
There was a problem hiding this comment.
|
|
||
| assert autolink_doc("[custom text](`:lists.all/2`)") == | ||
| ~s|<a href="https://www.erlang.org/doc/man/lists.html#all-2">custom text</a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/lists.html#all/2">custom text</a>| |
Contributor
Author
There was a problem hiding this comment.
| test "Erlang stdlib types" do | ||
| assert autolink_spec(quote(do: t() :: :sets.set())) == | ||
| ~s[t() :: <a href="https://www.erlang.org/doc/man/sets.html#type-set">:sets.set</a>()] | ||
| ~s[t() :: <a href="https://www.erlang.org/doc/man/sets.html#t:set/0">:sets.set</a>()] |
Contributor
Author
There was a problem hiding this comment.
whatyouhide
changed the title
Contributor
Author
|
The tests in test/ex_doc/language/erlang_test.exs fail. These tests are excluded when I run I'll try to install Erlang with docs and fix/update those tests. |
Member
|
@ruslandoga you should also be able to fix the tests directly and let CI do the job for you. :) |
ruslandoga
commented
May 29, 2024
test/ex_doc/language/erlang_test.exs
Outdated
| test "OTP private type", c do | ||
| assert autolink_spec(~S"-spec foo() -> array:array_indx().", c) == | ||
| ~s|foo() -> <a href="https://www.erlang.org/doc/man/array.html#type-array_indx">array:array_indx</a>().| | ||
| ~s|foo() -> array:array_indx().| |
Contributor
Author
There was a problem hiding this comment.
ruslandoga
commented
May 29, 2024
| test "OTP type", c do | ||
| assert autolink_spec(~S"-spec foo() -> sets:set().", c) == | ||
| ~s|foo() -> <a href="https://www.erlang.org/doc/man/sets.html#type-set">sets:set</a>().| | ||
| ~s|foo() -> <a href="https://www.erlang.org/doc/man/sets.html#t:set/0">sets:set</a>().| |
Contributor
Author
There was a problem hiding this comment.
| test "OTP function", c do | ||
| assert autolink_extra("`lists:reverse/1`", c) == | ||
| ~s|<a href="https://www.erlang.org/doc/man/lists.html#reverse-1"><code class="inline">lists:reverse/1</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/lists.html#reverse/1"><code class="inline">lists:reverse/1</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "linking to auto-imported nil works", c do | ||
| assert autolink_doc("[`[]`](`t:nil/0`)", c) == | ||
| ~s|<a href="https://www.erlang.org/doc/man/erlang.html#type-nil"><code class="inline">[]</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/erlang.html#t:nil/0"><code class="inline">[]</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "type in module autoimport using slash", c do | ||
| assert autolink_doc("`t:integer/0`", c) == | ||
| ~s|<a href="https://www.erlang.org/doc/man/erlang.html#type-integer"><code class="inline">integer/0</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/erlang.html#t:integer/0"><code class="inline">integer/0</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "function in module autoimport using slash", c do | ||
| assert autolink_doc("`node/0`", c) == | ||
| ~s|<a href="https://www.erlang.org/doc/man/erlang.html#node-0"><code class="inline">node/0</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/erlang.html#node/0"><code class="inline">node/0</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "OTP function", c do | ||
| assert autolink_edoc("{@link array:new/0}", c) == | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#new-0"><code>array:new/0</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#new/0"><code>array:new/0</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| test "OTP type", c do | ||
| assert autolink_edoc("{@link array:array()}", c) == | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#type-array"><code>array:array()</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#t:array/0"><code>array:array()</code></a>| |
Contributor
Author
There was a problem hiding this comment.
| ~s|record(<a href="https://www.erlang.org/doc/man/erlang.html#type-module">module</a>())| <> | ||
| ~s| -> [[{<a href="https://www.erlang.org/doc/man/erlang.html#type-module">module</a>(),| <> | ||
| ~s| <a href="https://www.erlang.org/doc/man/erlang.html#type-atom">atom</a>()}]].| | ||
| ~s|record(<a href="https://www.erlang.org/doc/man/erlang.html#t:module/0">module</a>())| <> |
Contributor
Author
There was a problem hiding this comment.
| ~s| <a href="https://www.erlang.org/doc/man/erlang.html#type-atom">atom</a>()}]].| | ||
| ~s|record(<a href="https://www.erlang.org/doc/man/erlang.html#t:module/0">module</a>())| <> | ||
| ~s| -> [[{<a href="https://www.erlang.org/doc/man/erlang.html#t:module/0">module</a>(),| <> | ||
| ~s| <a href="https://www.erlang.org/doc/man/erlang.html#t:atom/0">atom</a>()}]].| |
Contributor
Author
There was a problem hiding this comment.
| c | ||
| ) == | ||
| ~S|foo() -> #{<a href="https://www.erlang.org/doc/man/erlang.html#type-atom">atom</a>() := <a href="https://www.erlang.org/doc/man/sets.html#type-set">sets:set</a>(<a href="https://www.erlang.org/doc/man/erlang.html#type-integer">integer</a>()), <a href="https://www.erlang.org/doc/man/erlang.html#type-float">float</a>() => <a href="#t:t/0">t</a>()}.| | ||
| ~S|foo() -> #{<a href="https://www.erlang.org/doc/man/erlang.html#t:atom/0">atom</a>() := <a href="https://www.erlang.org/doc/man/sets.html#t:set/1">sets:set</a>(<a href="https://www.erlang.org/doc/man/erlang.html#t:integer/0">integer</a>()), <a href="https://www.erlang.org/doc/man/erlang.html#t:float/0">float</a>() => <a href="#t:t/0">t</a>()}.| |
Contributor
Author
There was a problem hiding this comment.
Member
|
💚 💙 💜 💛 ❤️ |
Member
|
Beautiful! Can you also please send a PR that updates from doc/man to doc/apps/APP? Thank you! |
Contributor
Author
|
The next PR is ready for review: #1909 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #1907