Description
Elixir and Erlang/OTP versions
Erlang/OTP 27 [erts-15.0] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [jit:ns]
Elixir 1.18.4 (compiled with Erlang/OTP 27)
Operating system
Windows Subsystem for Linux
Current behavior
The intellisense for the Code.Typespec functions "View on Hexdocs" links takes the developer to a broken page: https://hexdocs.pm/elixir/1.18.4/Code.Typespec.html#fetch_types/1 because the module is marked with @moduledoc false
.
I'm wondering if there's a reason Code.Typespec isn't included in the documentation. I'm writing a little project that needed to read the type information and the fetch_types/1
and fetch_specs/1
functions are very useful and well-documented, even though the module is marked with @moduledoc false
.
It would make sense if this isn't generally a function people should use. I have a very weird and specific use-case and I would understand if this generally shouldn't be exposed in documentation to discourage its use in the typical application and to avoid bloating the documentation with every potentially useful function/module in the language.
If there isn't a reason, I'm happy to write a quick PR to update the attribute (and add/update any documentation if it's necessary to do so). If there is a reason (whether the ones I've predicted or another) I would be happy to hear it and feel free to close the issue. Thank you!
Expected behavior
I would expect the modules documentation to be included on hexdocs, unless there's a reason it's being omitted, then feel free to close this issue.