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

Unable to document @data #163

Open
ParadaCarleton opened this issue May 12, 2023 · 1 comment
Open

Unable to document @data #163

ParadaCarleton opened this issue May 12, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@ParadaCarleton
Copy link

As in the title, it's not currently possible to document Structs created using the @data macro; adding a docstring above them results in an error. (You can attach the docstring further down, but that makes the code a bit harder to read.)

Relatedly, the current naming of ADTs as x's constructor makes it a bit harder to document them. Could you explain what's going on with them?

@thautwarm thautwarm added the enhancement New feature or request label Jun 13, 2023
@kapple19
Copy link

The error that gets reported is '@data' not documentable so do I understand correctly that the data macro needs to recognise and correctly handle when the expression it receives starts with a string?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants