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

Allow roxygen comments in object to be documented #397

Merged
merged 4 commits into from Oct 20, 2015
Merged

Allow roxygen comments in object to be documented #397

merged 4 commits into from Oct 20, 2015

Conversation

@krlmlr
Copy link
Member

@krlmlr krlmlr commented Oct 11, 2015

useful e.g. to document implementation details inline

Example:

func <- function(a) {
  #' @param a an integer
  stopifnot(is.integer(a))

  #' @details obtw: this is how it works internally...
}
useful e.g. to document implementation details inline
@hadley
Copy link
Member

@hadley hadley commented Oct 12, 2015

Hmmmmmmmmm. On one hand, I like the idea for RC/R6 and the implementation is simple. OTOH, I'd prefer to enforce a consistent style of roxygen usage. Let me sit on it for a bit.

@krlmlr
Copy link
Member Author

@krlmlr krlmlr commented Oct 20, 2015

As discussed: Added tests, no off-by-one errors found.

hadley added a commit that referenced this issue Oct 20, 2015
Allow roxygen comments in object to be documented
@hadley hadley merged commit dccf9de into r-lib:master Oct 20, 2015
1 check passed
@krlmlr krlmlr deleted the inline-rox branch Oct 20, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants