Hi all, I’ve been playing with Specify lately and I’m trying to get the @type module attribute like the @doc one, so as to link to that type in my documentation. Configuration looks like this: Specify.defconfig do @doc "there are no floors for me to sweep" @type floors_to_sweep :: non_…

Yeah, you can’t get @type, @spec , @callback and friends because they have special semantics. Usually, what is stored in a module attribute is evaluated, if you do @foo 1 + 1, the value of @foo is the result of 1 + 1. For typespecs, we actually receive an AST that we process, and returning that would…

Interesting use case! Currently, when you add @type-annotations inside the defconfig, they will end up being shown in the documentation just as if they were written outside of the defconfig. So t YourModule.floors_to_sweep would work in IEx, and in the compiled HTML documentation, the type would a…

Thanks for your answers. @Qqwy : not sure to understand and if it’s the same use case :slight_smile: . Mine is mainly about documenting hundreds (if not more) configuration options including many callbacks with most of the time different signatures, and linking between them (config option ↔ type), a…

[image] tangui: Thanks for your answers. @Qqwy : not sure to understand and if it’s the same use case :slight_smile: . Mine is mainly about documenting hundreds (if not more) configuration options including many callbacks with most of the time different signatures, I think this part is alread…

[image] Qqwy: This is indeed not something that Specify currently helps you with. It definitely would be interesting to automate the generation of a ‘config typespec’ in some way. Maybe the field types can be inferred from the parser function’s spec, and we can then define a type for the config …

I’m fairly certain this is what Code.Typespec is meant to be used for. We could (as long as the parser function is readable as an invocation of a certain MFA) call Code.Typespec.fetch_specs(module), find the appropriate function’s spec in the response, and then use Code.Typespec.spec_to_quoted to t…

I’m now trying to get the @moduledoc module attribute in a __using__ macro but in: {line_number, existing_moduledoc} = Module.delete_attribute(__MODULE__, :moduledoc) || {0, ""} Module.put_attribute( __MODULE__, :moduledoc, {line_number, existing_moduled…

[image] josevalim: Yeah, you can’t get @type, @spec , @callback and friends because they have special semantics. Is this still true today? Or there are ways to get the type specs for functions now.

Afaik there is still no public API for doing so. :frowning:

Getting the @type module attribute

Questions & Help Questions

jackalcooper March 19, 2022, 10:58am 9

Is this still true today? Or there are ways to get the type specs for functions now.