-
Notifications
You must be signed in to change notification settings - Fork 86
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
Cannot add documentation for functor arguments #1047
Comments
I think that documentation comments on functor parameter definitions would be a good addition to the language. But until this is implemented and accepted upstream, perhaps we could handle I suggest attaching |
While writing the documentation for a project, it appeared to me that
odoc
was generating a category for the parameters of my functor:However, even when trying to add a comment to my functor argument (I tried several things),
odoc
seemed to ignore them whileocamlformat
was giving me the following error:Would it be possible to add the support for such a thing ? The error from
ocamlformat
& a private disussion with @Julow seems to indicate that it would not be that easy and would require some changes to the compiler, but it would be a really nice addition to be able to directly comment them and use theParameters
category rather than use@param
inside the functor's documentation.The text was updated successfully, but these errors were encountered: