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

Add automatic docstrings to functions in API module #651

Closed
giordano opened this issue Sep 30, 2022 · 1 comment · Fixed by #652
Closed

Add automatic docstrings to functions in API module #651

giordano opened this issue Sep 30, 2022 · 1 comment · Fixed by #652

Comments

@giordano
Copy link
Member

Now that we have full low-level API, I think it'd be nice to have it in the documentation. But this would require attaching a docstring (with link to MPICH docs?) to the automatically generated methods, which at the moment don't have a type signature. No idea how feasible is that with Clang.jl.

CC: @t-bltg

@t-bltg
Copy link
Collaborator

t-bltg commented Sep 30, 2022

Fair enough, I'll see what I can do (we systematically think about the docs later 😆).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants