Skip to content

Commit ed77f05

Browse files
committed
docs: skip autolink for hidden Native fns in the changelog
`mix publisho` promoted the RELEASE.md notes into CHANGELOG.md, an ex_doc extra. Those notes reference the hidden `Emily.Native.async_eval/2` and `Emily.Native.fast_rope_int/8` NIF stubs, so `mix docs --warnings-as-errors` (the precommit / CI docs gate) failed on the unresolved autolinks. Add both to `:skip_code_autolink_to` and note the fix in RELEASE.md.
1 parent 3683751 commit ed77f05

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

RELEASE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Fixed
2+
3+
- Documentation no longer fails to build over autolink references to the
4+
hidden `Emily.Native.async_eval/2` and `Emily.Native.fast_rope_int/8`
5+
NIF stubs in the changelog; both are excluded from ex_doc autolinking.

mix.exs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,8 @@ defmodule Emily.MixProject do
222222
"Emily.Native.from_binary/3",
223223
"Emily.Native.conv_general/8",
224224
"Emily.Native.worker_queue_depth/1",
225+
"Emily.Native.async_eval/2",
226+
"Emily.Native.fast_rope_int/8",
225227
# Native Expr-compiler internals are `@moduledoc false`.
226228
"Emily.IR",
227229
"Emily.Program",

0 commit comments

Comments
 (0)