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

docstrings #323

Open
soniamitchell opened this issue Feb 25, 2021 · 4 comments
Open

docstrings #323

soniamitchell opened this issue Feb 25, 2021 · 4 comments
Labels
suggestions Suggestions

Comments

@soniamitchell
Copy link
Contributor

Remove docstrings

  • If we're advocating writing packages then docstrings are only briefly useful in Series 2
  • If they're used in Series 3 (in packaged functions), they cause roxygen2 to generate a warning
@richardreeve
Copy link
Member

I'm in two minds about this - I like being able to show documentation for functions not in packages, but it's not ideal.

@soniamitchell
Copy link
Contributor Author

I wouldn’t mind if it wasn’t for the fact that series 3, 4, and the final project are package focused.

@richardreeve
Copy link
Member

Yes, you're probably right. Maybe we just demonstrate it at some point, but don't ask them to use it.

@soniamitchell
Copy link
Contributor Author

I think presenting multiple ways of doing something invites confusion. It's fun to learn new ways of doing things if you're already familiar with R, but as a beginner it might not be so helpful?

@soniamitchell soniamitchell added the suggestions Suggestions label Nov 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
suggestions Suggestions
Projects
None yet
Development

No branches or pull requests

2 participants