Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
inoas-nbw opened this issue Apr 19, 2024 · 2 comments
Open

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

inoas-nbw opened this issue Apr 19, 2024 · 2 comments
Labels
good first issue Good for newcomers help wanted Contributions encouraged priority:medium

Comments

@inoas-nbw
Copy link

inoas-nbw commented Apr 19, 2024

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
Copy link
Member

lpil commented Apr 19, 2024

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

@lpil lpil added help wanted Contributions encouraged good first issue Good for newcomers priority:medium labels Apr 19, 2024
@inoas
Copy link
Contributor

inoas commented Apr 19, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Contributions encouraged priority:medium
Projects
None yet
Development

No branches or pull requests

3 participants