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 missing "should" to roxygen docs #592

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mthomas-ketchbrook
Copy link

Thanks so much for this package! It's a huge lifesaver for a lot of my team's work.

I found what I think was a missing (and important) "should" keyword in the documentation for the req_auth_basic() function. When adding this word to the roxygen param, I kept the line width to 80 characters.

Let me know if you'd like me to add another commit that also updates the associated .Rd file, or if that is part of the automated build process.

@hadley
Copy link
Member

hadley commented Dec 4, 2024

/document

@hadley
Copy link
Member

hadley commented Dec 4, 2024

@mthomas-ketchbrook in general, it's slightly more convenient if you include the generated .Rd file, but it's also very easy for me to add after the fact.

Thanks for fixing this!

@mthomas-ketchbrook
Copy link
Author

@hadley I will make sure to do that going forward -- thank you!

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

Successfully merging this pull request may close these issues.

2 participants