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

Documentation for tags #1375

Closed
romainfrancois opened this issue Jun 29, 2022 · 1 comment · Fixed by #1402
Closed

Documentation for tags #1375

romainfrancois opened this issue Jun 29, 2022 · 1 comment · Fixed by #1402
Labels
feature a feature request or enhancement

Comments

@romainfrancois
Copy link
Contributor

It would be useful to have some sort of documentation for each tag, so that e.g. we could show it in completion popups:

image

Maybe a "doc" attribute for a function related to the tag, e.g.

attr(roxy_tag_parse.roxy_tag_rdname, "doc") <- "Something useful about the @rdname tag"
@gaborcsardi gaborcsardi added the feature a feature request or enhancement label Jun 29, 2022
@hadley
Copy link
Member

hadley commented Jul 10, 2022

Also need to record whether or not they take arguments (so IDE knows whether to insert space or not), and might be worth somehow associating with a roclet so we could also use to generate an automated list for roxygen2 docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants