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

Standardize function documentation #23

Open
msleckman opened this issue Aug 10, 2022 · 0 comments
Open

Standardize function documentation #23

msleckman opened this issue Aug 10, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@msleckman
Copy link
Collaborator

msleckman commented Aug 10, 2022

Standardize whether function doc strings sit before or after function body.

Great job on the documentation throughout. Typically doc for R functions sits outside the function body, rather than inside:

#' @description stuff here
#' @param a stuff here
#' @param b more stuff here

foo <- function(a, b) {
#even more stuff
}

Question for you - is it the other way in python?

Originally posted by @padilla410 in #16 (comment)

@msleckman msleckman added the documentation Improvements or additions to documentation label Dec 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants