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

@family should return links to fn() not fn #815

Closed
DavisVaughan opened this issue Oct 29, 2018 · 1 comment
Closed

@family should return links to fn() not fn #815

DavisVaughan opened this issue Oct 29, 2018 · 1 comment
Labels
Milestone

Comments

@DavisVaughan
Copy link
Member

@DavisVaughan DavisVaughan commented Oct 29, 2018

Currently, the family tag returns:

Other great functions: fn1, fn2

To be in line with the tidyverse style guide, it might be useful to return:

Other great functions: fn1(), fn2()

The change could be made here, I believe:
https://github.com/klutometis/roxygen/blob/be3ef309381923e64337c3324510746990fde62f/R/rd-family.R#L18

Edit) I am not sure if the family tag is ever used to link to things other than functions, but that might be something to consider as a reason not to do this.

@gaborcsardi
Copy link
Collaborator

@gaborcsardi gaborcsardi commented Oct 29, 2018

Yeah, for the proper solution, we would need to check whether the linked thing is a function or not. Roxygen knows it, so it is not hopeless.

@hadley hadley added the feature label Jul 20, 2019
@hadley hadley added this to the v6.2.0 milestone Aug 22, 2019
@hadley hadley closed this in f28b184 Sep 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants