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

periods between names in @family attribute #477

Closed
kevinushey opened this issue May 26, 2016 · 0 comments
Closed

periods between names in @family attribute #477

kevinushey opened this issue May 26, 2016 · 0 comments

Comments

@kevinushey
Copy link
Contributor

@kevinushey kevinushey commented May 26, 2016

When a package contains only one unique @family tag, e.g.

@family scope-related functions

roxygen2 mutates the name to

scope.related.functions

This seems to be caused by the definition of invert. A small reproducible example:

data <- structure(list(defer.Rd = "scope-related functions", scope_dir.Rd = "scope-related functions", 
    scope_env_vars.Rd = "scope-related functions", scope_options.Rd = "scope-related functions"), .Names = c("defer.Rd", 
"scope_dir.Rd", "scope_env_vars.Rd", "scope_options.Rd"))
roxygen2:::invert(data)

This could be fixed by avoiding the use of stack(), unstack() in invert: https://github.com/klutometis/roxygen/blob/master/R/family.R#L29-L32

kevinushey added a commit to kevinushey/roxygen that referenced this issue May 26, 2016
@hadley hadley closed this in d17e045 Aug 29, 2016
hadley added a commit that referenced this issue Aug 29, 2016
avoid insertion of '.' between words in '@family' tag (closes #477)
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
1 participant