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

make it possible to not reference all aliases with @family #283

Closed
thomasp85 opened this issue Sep 25, 2014 · 6 comments
Closed

make it possible to not reference all aliases with @family #283

thomasp85 opened this issue Sep 25, 2014 · 6 comments

Comments

@thomasp85
Copy link
Member

@thomasp85 thomasp85 commented Sep 25, 2014

It seems @family uses aliases to create cross-linking between documentation. Sometimes this is not desired as it can inflate the size of the see also section if there is cross-linking between classes with a lot of accessors documented with the class.

Is it possible to provide a toggle or a new tag that only takes the name into account?

@gaborcsardi
Copy link
Collaborator

@gaborcsardi gaborcsardi commented Jan 28, 2015

This would be great indeed. I think it has little use to include 5-10 links that point to the same manual page....

@gaborcsardi
Copy link
Collaborator

@gaborcsardi gaborcsardi commented Jan 28, 2015

FWIW, it is easy to change to this behavior (obviously): https://github.com/gaborcsardi/roxygen/commit/796fc0b2b8a79241524864f6d23ac50bcdea22a2

I am not sure what the best way would be to provide a toggle.

@thomasp85
Copy link
Member Author

@thomasp85 thomasp85 commented Jun 4, 2015

What is the status on this? Lack of time, disagreement on the feature, or something else?

@hadley
Copy link
Member

@hadley hadley commented Jun 5, 2015

I'd be happy to review a PR

@thomasp85
Copy link
Member Author

@thomasp85 thomasp85 commented Jun 5, 2015

Would you prefer a change in behaviour of the current @family tag or the creation of a new e.g. @smallFamily?

Den 05/06/2015 kl. 17.10 skrev Hadley Wickham notifications@github.com:

I'd be happy to review a PR


Reply to this email directly or view it on GitHub.

@hadley
Copy link
Member

@hadley hadley commented Jun 5, 2015

Change current behaviour

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
3 participants