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

Support Haddock documentation for generated code #2

Open
typedbyte opened this issue Dec 24, 2020 · 0 comments
Open

Support Haddock documentation for generated code #2

typedbyte opened this issue Dec 24, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@typedbyte
Copy link
Owner

typedbyte commented Dec 24, 2020

As far as I know, it is currently not possible to include Haddock documentation in the code generated by Template Haskell (see the related ticket). As a consequence, declarations generated by functions like makeTaggedEffect, makeTagger and makeUntagged currently have no documentation. This is no big problem, since the documentation is usually attached to the tagged counterparts of the generated declarations, but it is a situation that can be improved nonetheless.

For single declarations generated by makeUntagged, one can currently document them like this ...

-- | The untagged version of 'runLocalFileSystem''.
makeUntagged ['runLocalFileSystem']

... but in the future, I would like to copy the documentation over from the original tagged declarations, which means that no manual handiwork is needed. Guess we have to wait until the related ticket is resolved.

@typedbyte typedbyte added the documentation Improvements or additions to documentation label Dec 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant