openpharma / roxytypes

typed parameter definitions for `roxygen2`
https://openpharma.github.io/roxytypes/
Other
5 stars 1 forks source link

Discussion: tag names #4

Open dgkf opened 1 year ago

dgkf commented 1 year ago

While this is still in early development, I want to float a few alternatives for tag names. The goal is that they're descriptive, succinct and memorable. If you have another idea and want to add it, reply and I'll add it to the table.

@param tag @return tag descriptive memorable succinct
@typedparam @typedreturn :+1: :+1: :-1:
@tparam @treturn :shrug: :shrug: :+1:
@typaram @tyreturn :shrug: :shrug: :+1:
@typepar @typeret :shrug: :shrug: :+1:
@typed :shrug: :shrug: :+1:
@result :-1: :shrug: :+1:
danielinteractive commented 1 year ago

How about @typepar and @typeret ? :-)