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

Handle documentation for unexposed code #46

Open
daniels opened this issue Apr 14, 2021 · 1 comment
Open

Handle documentation for unexposed code #46

daniels opened this issue Apr 14, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@daniels
Copy link

daniels commented Apr 14, 2021

Thank you for this useful tool! It is really designed in the spirit of Elm and helps guiding me through my documentation task.

Is there any way documentation comments for unexposed functions and types could be added to the generated documentation for applications? I realise this is not how it works on Elm Packages, but on the other hand applications aren't documented there at all.

Use case: I try to document an application for my colleagues, and I think they would appreciate being able to browse the complete documentation with elm-doc-preview. But as I've tried to only expose what is necessary, a large part of the application code is internal to the modules and much of the documentation comments I add doesn't show up in the preview.

Just reading the comments in the code is of course a valid work around, although not as pleasant.

@rlefevre rlefevre added the enhancement New feature or request label Dec 11, 2024
@rlefevre
Copy link
Member

rlefevre commented Dec 11, 2024

This is currently complicated as the underlying core elm doc generation tool does not support documentating unexposed symbols.

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

2 participants