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

Fix documentation #15

Open
sckott opened this issue Nov 28, 2013 · 0 comments
Open

Fix documentation #15

sckott opened this issue Nov 28, 2013 · 0 comments
Labels

Comments

@sckott
Copy link
Contributor

sckott commented Nov 28, 2013

Hi @DASpringate Seems like many of the helper functions should changed in one of two ways. 1) remove all roxygen style docs and don't export them, or 2) use roxygen style docs, but if you do, you have to document parameter names, etc. or check isn't happy.

For example, in rpubmed_fetch file you have this function https://github.com/ropensci/rpubmed/blob/master/R/rpubmed_fetch.R#L59-L62 that has some roxygen docs, which then creates a .Rd file in the man/ directory, but because parameters aren't documented, check throws errors.

Do you want these helper functions internal only? Are they not supposed to be avail to users?

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

No branches or pull requests

1 participant