We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
You can use Markdown in roxygen function documentation, as per the {roxygen2} guidance.
Some of these are like normal Markdown, like backticks for code, but others are less obvious, like the [text][ref] format.
[text][ref]
Perhaps use different function suffixes for the md vs rd approaches, like md_*() and roxy_*() or whatever.
md_*()
roxy_*()
Would probably want a new section in the reference tab of the pkgdown site as well.
The text was updated successfully, but these errors were encountered:
No branches or pull requests
You can use Markdown in roxygen function documentation, as per the {roxygen2} guidance.
Some of these are like normal Markdown, like backticks for code, but others are less obvious, like the
[text][ref]format.Perhaps use different function suffixes for the md vs rd approaches, like
md_*()androxy_*()or whatever.Would probably want a new section in the reference tab of the pkgdown site as well.
The text was updated successfully, but these errors were encountered: