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

Update docs with description tags where needed #288

Open
sjspielman opened this issue Dec 20, 2024 · 0 comments
Open

Update docs with description tags where needed #288

sjspielman opened this issue Dec 20, 2024 · 0 comments
Assignees

Comments

@sjspielman
Copy link
Member

sjspielman commented Dec 20, 2024

It turns out that the "description" sections for roxygen docs don't get fully rendered if there are line paragraph breaks but there is no literal @description tag: https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html#the-introduction

This definitely affects a couple functions in scpcaTools, so we should go through functions to make sure all the docs end up as part of the docs.

Edit:
Back to note that this wasn't exactly correct - docs are all present, but the ones following paragraph breaks are just in a different docs section, which isn't strictly a problem!

Therefore, we should instead ensure that our docs follow the R standard for docs organization, as described in AlexsLemonade/rOpenScPCA#26

@sjspielman sjspielman self-assigned this Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant