feat(roxygen): Add roxygen tag for typed parameters/returns
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- r
- Domain
- documentation
Research direction
Start by inspecting the repository for its roxygen parsing or documentation-generation entry points and existing tests for parameter tags. Compare the proposed @paramt syntax with the example output, then define and test behavior that consistently renders the parameter type separately from its description.
Written by the indexing model from the issue text.
Description
I often find myself re-writting the same statements for typed parameters:
#' @param x A `character` vector [blah blah blah]
Shoving type information into plain text is a bit messy and would benefit from having a more consistent shorthand. At least for now, just having something that might parse and produce something better formatted would be nice:
#' @paramt x [`character`] blah blah blah
That produces
\arguments{
\item{x \code{character}}{
blah blah blah
}
}
Would help to give the type information a more dedicated space in the documentation and consistently format it.
- Dominant language
- R
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Similar issues
-
documentation pkg infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
epiverse-trace/epiparameter#511 ·
-
function:write_dwc
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Urgent request: Due to vulnerabilities move to API version 12.6.1 (12.6.2 eventually) or 13.1.1 Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
jbkunst/highcharter#849 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
r-lib/pkgdepends#485 · 3 comments ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100