documentation feature request - please link to documentation explaining exactly what a roclet is, or omit the term from the documentation

[mccroweyclinton-EPA]

For years I have wondered what exactly is a roclet. Roxygen2's vignettes and a few of the manual pages includes the term 'roclet' in the documentation but I have yet to see any documentation, anywhere explaining exactly what a roclet is. This could be confusing to people learning about writing proper R documentation files as it was for me when I was first getting started using roxygen2.

I have been using roxygen2 for years and I think I am just now starting to understand what a roclet is. If the developers do not think an explanation of what a roclet is should be included in the documentation, then please omit the term from roxygen2's documentation altogether so that other new users do not have to endure the same state of confusion as I did.

Thank you for your consideration.

[ramiromagno]

See #1086.

[mccroweyclinton-EPA]

Thanks for linking me to that issue. I think I've figured that part out myself. The point of me making this issue was to request that this explanation be added to the documentation itself. Users shouldn't have to search through roxygen issues on github to discover what a roclet is.

Seeing that there is someone else that had the same issue as I understanding what exactly is a roclet, I am suggesting that a short blurb giving the definition of a roclet be included in the documentation or the documentation be writting in such a way that the term "roclet" is not included.

Thank you for your consideration.