replace OTP /man/ links with /apps/:app/ #1909
Merged
Conversation
This file contains 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 30, 2024
|
|
||
| assert html =~ | ||
| ~s|-type</span> t() :: <a href=\"https://www.erlang.org/doc/man/erlang.html#t:atom/0\">atom</a>().| | ||
| ~s|-type</span> t() :: <a href="https://www.erlang.org/doc/apps/erts/erlang.html#t:atom/0">atom</a>().| |
There was a problem hiding this comment.
ruslandoga
commented
May 30, 2024
|
|
||
| assert html =~ | ||
| ~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}.| | ||
| ~s|-type</span> t2() :: #rec{k1 :: <a href="https://www.erlang.org/doc/apps/stdlib/uri_string.html#t:uri_string/0">uri_string:uri_string</a>(), k2 :: <a href="https://www.erlang.org/doc/apps/stdlib/uri_string.html#t:uri_string/0">uri_string:uri_string</a>() \| undefined}.| |
There was a problem hiding this comment.
| @@ -40,12 +40,12 @@ defmodule ExDoc.Language.ElixirTest do | |||
|
|
|||
| test "m:module with Erlang module" do | |||
| assert autolink_doc("`m::array`") == | |||
| ~s|<a href="https://www.erlang.org/doc/man/array.html"><code class="inline">:array</code></a>| | |||
| ~s|<a href="https://www.erlang.org/doc/apps/stdlib/array.html"><code class="inline">:array</code></a>| | |||
There was a problem hiding this comment.
| @@ -99,7 +99,7 @@ defmodule ExDoc.Language.ElixirTest do | |||
|
|
|||
| 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/apps/stdlib/lists.html#all/2"><code class="inline">:lists.all/2</code></a>| | |||
There was a problem hiding this comment.
| end | ||
|
|
||
| test "m:module with Erlang module and fragment" do | ||
| assert autolink_doc("`m::array#fragment`") == | ||
| ~s|<a href="https://www.erlang.org/doc/man/array.html#fragment"><code class="inline">:array</code></a>| | ||
| ~s|<a href="https://www.erlang.org/doc/apps/stdlib/array.html#fragment"><code class="inline">:array</code></a>| |
There was a problem hiding this comment.
There was a problem hiding this comment.
And this is good as well. :) I checked, I just didn't comment. My bad. :)
| @@ -150,7 +150,7 @@ defmodule ExDoc.Language.ElixirTest do | |||
|
|
|||
| 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#c:handle_call/3"><code class="inline">:gen_server.handle_call/3</code></a>| | |||
| ~s|<a href="https://www.erlang.org/doc/apps/stdlib/gen_server.html#c:handle_call/3"><code class="inline">:gen_server.handle_call/3</code></a>| | |||
There was a problem hiding this comment.
| @@ -563,7 +563,7 @@ defmodule ExDoc.Language.ErlangTest do | |||
|
|
|||
| test "OTP module", c do | |||
| assert autolink_extra("`m:rpc`", c) == | |||
| ~s|<a href="https://www.erlang.org/doc/man/rpc.html"><code class="inline">rpc</code></a>| | |||
| ~s|<a href="https://www.erlang.org/doc/apps/kernel/rpc.html"><code class="inline">rpc</code></a>| | |||
There was a problem hiding this comment.
| ~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>()}]].| | ||
| ~s|record(<a href="https://www.erlang.org/doc/apps/erts/erlang.html#t:module/0">module</a>())| <> |
There was a problem hiding this comment.
| @@ -724,7 +724,7 @@ defmodule ExDoc.Language.ErlangTest do | |||
| ~S"-spec foo() -> #{atom() := sets:set(integer()), float() => t()}.", | |||
| c | |||
| ) == | |||
| ~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>()}.| | |||
| ~S|foo() -> #{<a href="https://www.erlang.org/doc/apps/erts/erlang.html#t:atom/0">atom</a>() := <a href="https://www.erlang.org/doc/apps/stdlib/sets.html#t:set/1">sets:set</a>(<a href="https://www.erlang.org/doc/apps/erts/erlang.html#t:integer/0">integer</a>()), <a href="https://www.erlang.org/doc/apps/erts/erlang.html#t:float/0">float</a>() => <a href="#t:t/0">t</a>()}.| | |||
There was a problem hiding this comment.
| end | ||
|
|
||
| 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#t:array_indx/0">array:array_indx</a>().| | ||
| ~s|foo() -> <a href="https://www.erlang.org/doc/apps/stdlib/array.html#t:array_indx/0">array:array_indx</a>().| |
There was a problem hiding this comment.
| @@ -93,7 +93,7 @@ defmodule ExDoc.Retriever.ErlangTest do | |||
| assert function1.doc_file =~ "mod.erl" | |||
|
|
|||
| assert Erlang.autolink_spec(hd(function1.specs), current_kfa: {:function, :function1, 0}) == | |||
| "function1() -> <a href=\"https://www.erlang.org/doc/man/erlang.html#type-atom\">atom</a>()." | |||
There was a problem hiding this comment.
These links weren't updated in the previous PR since I missed these EEP 0059 tests. I still can't make them run with my Erlang installation, (I installed Erlang 27.0 with docs and now these tests are included)
And it doesn't seem like CI is running them either since they passed when they shouldn't have in the prev PR. I guess CI needs Erlang 27.0 for these tests to run?
There was a problem hiding this comment.
Some of the tests are failing for me locally:
$ elixir -v
Erlang/OTP 27 [erts-15.0] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [jit]
Elixir 1.17.0-rc.0 (a2600ea) (compiled with Erlang/OTP 27)
$ mix test test/ex_doc/retriever/erlang_test.exs
Running ExUnit with seed: 710493, max_cases: 16
.
1) test docs_from_modules/2 types (ExDoc.Retriever.ErlangTest)
test/ex_doc/retriever/erlang_test.exs:274
Assertion with == failed
code: assert type1.spec |> Erlang.autolink_spec(current_kfa: {:type, :type1, 0}) ==
"type1() :: <a href=\"https://www.erlang.org/doc/man/erlang.html#type-atom\">atom</a>()."
left: "type1() :: <a href=\"https://www.erlang.org/doc/apps/erts/erlang.html#t:atom/0\">atom</a>()."
right: "type1() :: <a href=\"https://www.erlang.org/doc/man/erlang.html#type-atom\">atom</a>()."
stacktrace:
test/ex_doc/retriever/erlang_test.exs:308: (test)
.
2) test docs_from_modules/2 function with no docs is generated (ExDoc.Retriever.ErlangTest)
test/ex_doc/retriever/erlang_test.exs:216
** (MatchError) no match of right hand side value: {[], []}
code: {[mod], []} = Retriever.docs_from_modules([:mod], %ExDoc.Config{})
stacktrace:
test/ex_doc/retriever/erlang_test.exs:224: (test)
....
3) test docs_from_modules/2 module with no docs is generated (ExDoc.Retriever.ErlangTest)
test/ex_doc/retriever/erlang_test.exs:11
match (=) failed
code: assert {[_], []} = Retriever.docs_from_modules([:mod], %ExDoc.Config{})
left: {[_], []}
right: {[], []}
stacktrace:
test/ex_doc/retriever/erlang_test.exs:16: (test)
.
4) test docs_from_modules/2 records (ExDoc.Retriever.ErlangTest)
test/ex_doc/retriever/erlang_test.exs:318
** (MatchError) no match of right hand side value: {[], []}
code: {[mod], []} = Retriever.docs_from_modules([:mod], config)
stacktrace:
test/ex_doc/retriever/erlang_test.exs:337: (test)
.
Finished in 0.4 seconds (0.4s async, 0.00s sync)
12 tests, 4 failuresThere was a problem hiding this comment.
They passed for me here but I am running against Erlang main. I will try to reproduce on a 27 release later!
|
💚 💙 💜 💛 ❤️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR continues #1908 and replaces https://www.erlang.org/doc/man/ links with https://www.erlang.org/doc/apps/APP