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

Test failures in ExDoc.Language.ErlangTest #1515

Closed
Odaeus opened this issue Feb 14, 2022 · 2 comments · Fixed by #1516
Closed

Test failures in ExDoc.Language.ErlangTest #1515

Odaeus opened this issue Feb 14, 2022 · 2 comments · Fixed by #1516

Comments

@Odaeus
Copy link
Contributor

Odaeus commented Feb 14, 2022

With the latest head (277c401) I get 6 test failures in the form:

Generated ex_doc app
......................................................................................................................................................................................warning: documentation references module "array" but it is limited
  nofile



  1) test autolink_doc/2 module with anchor (ExDoc.Language.ErlangTest)
     test/ex_doc/language/erlang_test.exs:44
     Assertion with == failed
     code:  assert do_autolink_doc(ast) ==
              ~s"<a href=\"https://www.erlang.org/doc/man/array.html#anchor\"><code>array</code></a>"
     left:  "<code>array</code>"
     right: "<a href=\"https://www.erlang.org/doc/man/array.html#anchor\"><code>array</code></a>"
     stacktrace:
       test/ex_doc/language/erlang_test.exs:49: (test)

  2) test autolink_doc/2 custom text (ExDoc.Language.ErlangTest)
     test/ex_doc/language/erlang_test.exs:60
     Assertion with == failed
     code:  assert autolink_doc("{@link array. The <code>array</code> module}", c) ==
              ~s"<a href=\"https://www.erlang.org/doc/man/array.html\">The <code>array</code> module</a>"
     left:  "The <code>array</code> module"
     right: "<a href=\"https://www.erlang.org/doc/man/array.html\">The <code>array</code> module</a>"
     stacktrace:
       test/ex_doc/language/erlang_test.exs:61: (test)

..warning: documentation references module "array" but it is limited
  nofile

This is with a clean repo and running mix setup.

$ elixir --version
Erlang/OTP 24 [erts-12.2.1] [source] [64-bit] [smp:5:5] [ds:5:5:10] [async-threads:1]

Elixir 1.13.3 (compiled with Erlang/OTP 24)

$ uname -a
Linux gordo 5.13.0-28-generic #31-Ubuntu SMP Thu Jan 13 17:44:32 UTC 2022 aarch64 aarch64 aarch64 GNU/Linux

Obviously the tests pass on CI so it has something to do with my system, but wanted to report this in case anyone else hits this issue or someone has already solved it.

@josevalim
Copy link
Member

It is most likely that your Erlang version was not compiled with docs. @wojtekmach perhaps we should change the :otp24 tag to not be about otp24, but rather if there are docs for the Erlang modules.

@wojtekmach
Copy link
Member

@josevalim yup, good call

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.

3 participants