r-hyperspec / hySpc.read.txt

Import ASCII formatted data into hyperSpec
https://r-hyperspec.github.io/hySpc.read.txt/
MIT License
0 stars 1 forks source link

Use link to `hyperSpec` class in `@return` #68

Closed GegznaV closed 2 years ago

GegznaV commented 2 years ago

For functions, that return hyperSpec object, use link to hyperSpec class as follows:

#' @return [hyperSpec][hyperSpec::hyperSpec-class()] object.
bryanhanson commented 2 years ago

Just a quick comment about this issue. I recently learned and began using @template for documentation that occurs a lot of places and which one might want to fine tune or change from time-to-time. Very handy. Described here.