Skip to content

Conversation

@javobalazs
Copy link

No description provided.

@ejpcmac ejpcmac added this to the 0.3.1 milestone Oct 5, 2022
@ejpcmac ejpcmac added the T:Feature Type: Feature label Dec 29, 2023
@ejpcmac ejpcmac moved this from Backlog to Preparation in ejpcmac’s personal OSS work Oct 28, 2025
@ejpcmac ejpcmac moved this from Preparation to Ongoing in ejpcmac’s personal OSS work Oct 28, 2025
@ejpcmac ejpcmac moved this from Ongoing to In Review in ejpcmac’s personal OSS work Nov 8, 2025
ejpcmac added a commit that referenced this pull request Nov 8, 2025
Closes #37.

Co-authored-by: Balázs Jávorszky <javorszky.balazs@estyle.hu>
Co-authored-by: Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
ejpcmac added a commit that referenced this pull request Nov 8, 2025
Closes #37.

Co-authored-by: Balázs Jávorszky <javorszky.balazs@estyle.hu>
Co-authored-by: Jean-Philippe Cugnet <jean-philippe@cugnet.eu>
@ejpcmac
Copy link
Owner

ejpcmac commented Nov 8, 2025

Hello @javobalazs, thanks for your PR! Sorry not to have looked into it before, I only got back recently to open source maintenance.

As I had some nits and wanted to avoid bothering you with them after such a long time, I’ve rebased your commit on a separate branch and did the fixes myself.

Notably, providing :doc field attributes without an existing @typedoc on the struct now causes a warning and does not create a @typedoc. I’ve also updated the generated format for the field documentations to follow the same convention as the Elixir documentation:

@typedoc """
Some typed struct

## Fields

* `a_field` - its documentation
* `another_field` - another doc

I’ve added some tests as well.

@ejpcmac ejpcmac moved this from In Review to Solved in ejpcmac’s personal OSS work Nov 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

T:Feature Type: Feature

Projects

Status: Solved

Development

Successfully merging this pull request may close these issues.

2 participants