Skip to content

add_ functions do not all have roxygen comments #330

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

Closed
allaway opened this issue Jan 21, 2020 · 7 comments
Closed

add_ functions do not all have roxygen comments #330

allaway opened this issue Jan 21, 2020 · 7 comments
Labels
Difficulty: novice effort: low good first issue Good for newcomers hacktoberfest Issues for the hacktoberfest

Comments

@allaway
Copy link

allaway commented Jan 21, 2020

Perhaps I'm missing something obvious, but is there any reason that golem::add_fct/add_utils does not add a roxygen comment section to the resulting file like add_module does to the module files?
It seems like it would be helpful to add this for parity across the add_ functions and to encourage good documentation practices.

@allaway
Copy link
Author

allaway commented Jan 21, 2020

Related to #165

@ColinFay
Copy link
Member

You're right, there should be roxygen tags here.

Would you be willing to PR that?
I think we should do this in the spirit of the way add_module() works https://github.com/ThinkR-open/golem/blob/dev/R/add_modules.R#L71 (i.e with an export parameter to the function)

@novica
Copy link
Contributor

novica commented May 7, 2020

@ColinFay I would like to try to do this if no one is working on it.

My thinking is that first we should move

 write_there <- function(...){
      write(..., file = where, append = TRUE)
    } 

from add_modules.R so it can be reused to utils.R.
and then modify add_modules and add_r_files accordingly.
Does this make sense?

@allaway
Copy link
Author

allaway commented May 8, 2020 via email

@ColinFay ColinFay added Difficulty: novice effort: low good first issue Good for newcomers hacktoberfest Issues for the hacktoberfest labels Oct 1, 2020
@novica
Copy link
Contributor

novica commented Oct 7, 2020

Maybe: #525

@ColinFay
Copy link
Member

ColinFay commented Feb 4, 2021

This has been implemented in 4fc81ba :)

Thanks everyone for the ideas and for contributing 🤘

@ColinFay ColinFay closed this as completed Feb 4, 2021
@allaway
Copy link
Author

allaway commented Feb 4, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: novice effort: low good first issue Good for newcomers hacktoberfest Issues for the hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants