-
Notifications
You must be signed in to change notification settings - Fork 0
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 description to all exported function and their arguments #5
Labels
documentation
Improvements or additions to documentation
Comments
8 tasks
This should wait until #13 is closed. |
Hi @Theo-qua, I saw your comment on #17 (comment). Thanks for working on this. There seems to be a few missing parameters, however (see image below; I suppose the ones on the cpp file are easy to copy from the R counterpart): Also, please run |
wleoncio
added a commit
that referenced
this issue
Jan 12, 2024
wleoncio
added a commit
that referenced
this issue
Jan 12, 2024
wleoncio
added a commit
that referenced
this issue
Jan 12, 2024
Merged
Merged
wleoncio
added a commit
that referenced
this issue
Jan 12, 2024
wleoncio
added a commit
that referenced
this issue
Jan 12, 2024
Theo-qua
added a commit
that referenced
this issue
Jan 12, 2024
Fixed documentation for C++ function (#5)
wleoncio
added a commit
that referenced
this issue
May 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are several function descriptions/arguments that contain a placeholder "TODO:" tag. Exported functions are functions that the package user can directly access, so they should be well documented.
The text was updated successfully, but these errors were encountered: