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

Expand @includeRmd in the description section #970

Closed
lionel- opened this issue Nov 15, 2019 · 4 comments · Fixed by #982
Closed

Expand @includeRmd in the description section #970

lionel- opened this issue Nov 15, 2019 · 4 comments · Fixed by #982

Comments

@lionel-
Copy link
Member

@lionel- lionel- commented Nov 15, 2019

From @gaborcsardi: We can't have nested roxygen tags currently, but the section to expand to could be a parameter.

@gaborcsardi
Copy link
Collaborator

@gaborcsardi gaborcsardi commented Nov 15, 2019

#' @includeRmd description path/to/file.Rmd

might work. Somewhat ambiguous, but that's probably OK.

@gaborcsardi
Copy link
Collaborator

@gaborcsardi gaborcsardi commented Nov 20, 2019

@hadley: that's only because the Rmd starts with a ##, which creates a subsection. If you start with # or with just non-heading text, that'll go into @details I think.

@lionel-
Copy link
Member Author

@lionel- lionel- commented Nov 21, 2019

@hadley I hardcoded description in my local roxygen.

hadley pushed a commit that referenced this issue Nov 21, 2019
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 a pull request may close this issue.

3 participants