dgkf / dgkf/devutils

feat(roxygen): Add roxygen tag for typed parameters/returns

Open
#1 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
R
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I often find myself re-writting the same statements for typed parameters:

```r
#' @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:

```r
#' @paramt x [`character`] blah blah blah
```

That produces

```tex
\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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.