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 description to all exported function and their arguments #5

Closed
wleoncio opened this issue Jun 30, 2023 · 2 comments · Fixed by #20
Closed

Add description to all exported function and their arguments #5

wleoncio opened this issue Jun 30, 2023 · 2 comments · Fixed by #20
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@wleoncio
Copy link
Member

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.

@wleoncio wleoncio added the documentation Improvements or additions to documentation label Jun 30, 2023
@wleoncio
Copy link
Member Author

This should wait until #13 is closed.

@wleoncio
Copy link
Member Author

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):

bilde

Also, please run devtools::document() once you're done so the documentation files (*.Rd) can be updated.

wleoncio added a commit that referenced this issue Jan 12, 2024
Co-authored-by: Theophilus Quachie Asenso <85598983+Theo-qua@users.noreply.github.com>
Co-authored-by: Waldir Leoncio <w.l.netto@medisin.uio.no>
wleoncio added a commit that referenced this issue Jan 12, 2024
Co-authored-by: Theophilus Quachie Asenso <85598983+Theo-qua@users.noreply.github.com>
Co-authored-by: Waldir Leoncio <w.l.netto@medisin.uio.no>
wleoncio added a commit that referenced this issue Jan 12, 2024
wleoncio added a commit that referenced this issue Jan 12, 2024
@wleoncio wleoncio linked a pull request Jan 12, 2024 that will close this issue
wleoncio added a commit that referenced this issue Jan 12, 2024
Theo-qua 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
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants