Skip to content

Add Field Documentation for Messages#10

Merged
drowzy merged 6 commits intodrowzy:mainfrom
aj-foster:aj/docs-2
Nov 27, 2025
Merged

Add Field Documentation for Messages#10
drowzy merged 6 commits intodrowzy:mainfrom
aj-foster:aj/docs-2

Conversation

@aj-foster
Copy link
Contributor

Hello again 👋🏼

This PR adds field documentation to the @moduledoc for modules generated from messages. The first line of the field documentation is included in a summary table, while additional lines (if any) are relegated to an "Additional Notes" section at the end. We do this because ex_doc does not support both markdown-formatted and multi-line strings in table cells.

Care is again taken to handle edge cases related to indentation.

Please let me know if you are still interested in these kinds of enhancements.

@PragTob
Copy link

PragTob commented Jul 3, 2025

Heyo @drowzy - thanks for the library! 💚

Is there anything we can do to help move this PR forward?

IMG_20171221_144500

@drowzy drowzy merged commit d1208a6 into drowzy:main Nov 27, 2025
1 check passed
@drowzy
Copy link
Owner

drowzy commented Nov 27, 2025

Sorry for the delay and many thanks for the PR!

@PragTob
Copy link

PragTob commented Nov 27, 2025

Thanks for the merge! 🚀

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.

3 participants