OTP27 export moduledoc and doc for module docs and function docs

gleam-lang / gleam

⭐️ A friendly language for building type-safe, scalable systems!

https://gleam.run

Apache License 2.0

17.36k stars 722 forks source link

OTP27 export moduledoc and doc for module docs and function docs #3010

Open inoas-nbw opened 4 months ago

inoas-nbw commented 4 months ago

This EEP proposes two new attributes: -doc and -moduledoc. They could be used as follows:

See: https://www.erlang.org/eeps/eep-0059#new-module-attributes

Implemented in OTP 27 https://www.erlang.org/news/167#documentation

Maybe moduledoc false for @internal? https://www.erlang.org/eeps/eep-0059#hidden-docs

lpil commented 4 months ago

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

inoas commented 4 months ago

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.