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

Explicit @backref tag #294

Closed
krlmlr opened this issue Oct 10, 2014 · 4 comments · Fixed by #311
Closed

Explicit @backref tag #294

krlmlr opened this issue Oct 10, 2014 · 4 comments · Fixed by #311

Comments

@krlmlr
Copy link
Member

@krlmlr krlmlr commented Oct 10, 2014

... systems like Rcpp could use it to point you back to the original source location. (Reference)

What should be the semantics? Should it override the autogenerated source references? What should be the output?

@hadley
Copy link
Member

@hadley hadley commented Oct 10, 2014

Yes, it would just override the autogenerated reference. It would output the same thing as the autogenerated.

@hadley
Copy link
Member

@hadley hadley commented Dec 9, 2014

Can we close this now? This would be the same as @source, right?

@krlmlr
Copy link
Member Author

@krlmlr krlmlr commented Dec 9, 2014

I'm not sure -- @source shows in the generated .Rd files (as \source{...}), whereas @backref was intended to show only in the comment in the header. I think this is a useful feature and easy enough to add, I can take a look. (Is there a CRAN release in sight?)

@hadley
Copy link
Member

@hadley hadley commented Dec 9, 2014

Oops, I think I got confused with source, and what you implemented. Did you add an explicit tag?

I'm preparing for a release by the end of the week (mostly because it fixes a bug with dev stringr)

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.

2 participants