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

automatically generate usage section for dataset documentation #122

Closed
tobias-verbeke opened this issue Apr 15, 2013 · 1 comment
Closed

automatically generate usage section for dataset documentation #122

tobias-verbeke opened this issue Apr 15, 2013 · 1 comment

Comments

@tobias-verbeke
Copy link

@tobias-verbeke tobias-verbeke commented Apr 15, 2013

when documenting a dataset (@doctype data) and
if no @Usage tag is specified, the usage section in
the .Rd document should be populated using the
value of the @name tag, so if

@name someDataSet

is given in the roxygen comments, one would have

\usage{someDataSet}

in the resulting .Rd file.

Example from the datasets package
http://svn.r-project.org/R/trunk/src/library/datasets/man/ChickWeight.Rd

@hadley
Copy link
Member

@hadley hadley commented Nov 8, 2013

Fixed.

@hadley hadley closed this Nov 8, 2013
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 pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants