Yooo this rules!! Let's do it for sure

Cool. I may be alone with this but I think that gleam is not just great on itself but is the best way to create beam eco system libraries and this will help a lot <3.

Hey, I'm pretty interested in this feature (I made a post about it on discord yesterday), and was looking through the code exploring ways that it could potentially be added.

I was looking through the code and it looks like the function that generates erlang code is module_document. That takes a TypedModule, which includes a TypedDefinition, which has a TypedExpression, which has the Fn variant, but that variant doesn't carry the documentation info.

There is the get_documentation that allows you to get documentation from some of the TypedExpression variants (Var and ModuleSelect). So I was thinking at least the potential may be there to let the typed AST Fn carry around something from which its documentation could be recovered?

If that is way off track, do y'all have any ideas about how to go about adding this feature?

Module docs would be cool as well, but so far I have only tried looking into the function level docs.

I don't have any particular thoughts on the implementation, but I expect it to be fairly straightforward given we already use documentation for various things in the compiler.

Maybe we should wait until OTP26 is EOL'd before implementing this as it doesn't support these attributes?

Maybe we should wait until OTP26 is EOL'd before implementing this as it doesn't support these attributes?

At CodeBEAM someone showed a way to do it while keeping compatibility with lower OTP versions:

-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.

We could add this definition to the top of the generated modules.

Sneaky!