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

Include doc comments in generated Erlang code #4147

Merged
merged 6 commits into from
Jan 6, 2025

Conversation

giacomocavalieri
Copy link
Member

@giacomocavalieri giacomocavalieri commented Jan 5, 2025

This PR fixes #3010!

Function and module doc comments are includ
ed in the generated Erlang code, so one can now browse Gleam's documentation from the Erlang shell, like they would with any other Erlang module:

Screenshot 2025-01-05 alle 14 47 39
Screenshot 2025-01-05 alle 14 47 52

@giacomocavalieri giacomocavalieri mentioned this pull request Jan 5, 2025
@giacomocavalieri giacomocavalieri marked this pull request as ready for review January 5, 2025 13:57
Copy link
Member

@lpil lpil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice!! Thank you very much!

@lpil
Copy link
Member

lpil commented Jan 6, 2025

See the docs in the shell is so cool

@lpil lpil merged commit dedc913 into gleam-lang:main Jan 6, 2025
12 checks passed
@giacomocavalieri giacomocavalieri deleted the fix-3010 branch January 6, 2025 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OTP27 export moduledoc and doc for module docs and function docs
2 participants