General updates to Rd documentation #1246
Conversation
There was a problem hiding this comment.
The cleanups and extensions look good (and like they took a lot of tedious and careful work).
My inline comments are nearly all about existing typos that I spotted while going through the diff.
argument descriptions start with lower case and end with period.
Great, I think it's very nice to have consistency within a project.
When there's not a clear project preference (our projects in general are all over the place), I tend to start with an upper case letter to align with the tidyverse convention:
For most tags, like
@param,@seealsoand@return, the text should be a sentence, starting with a capital letter and ending with a full stop.
_pkgdown.yml
Outdated
| @@ -1,6 +1,7 @@ | |||
| template: | |||
| bootstrap: 5 | |||
| title: mrgsolve | |||
| url: https://github.com/metrumresearchgroup/mrgsolve | |||
There was a problem hiding this comment.
Hmm, isn't this supposed to be the URL of the pkgdown site? At least for auto-linking to work across packages, I think that the value in _pkgdown.yml should be https://mrgsolve.org/docs and then in DESCRIPTION the URL field should be
URL: https://mrgsolve.org/docs, https://github.com/metrumresearchgroup/mrgsolve
There was a problem hiding this comment.
I've been hesitant to list those urls in the package b/c I've been maintaining it and I know CRAN will complain if the url isn't reachable. Well, it's been stable for a while so will just go for it.
R/class_tgrid.R
Outdated
| #' @rdname tgrid | ||
| #' @name tgrid |
There was a problem hiding this comment.
[ not changed with this PR ]
This is one of several spots that use both @rdname and @name with the same value. In the case, I think rdname is unnecessary.
There was a problem hiding this comment.
I think they can both go? this documentation is associated with a function called tgrid().
Reformatting all documentation.
@mdwhere we make changes to the other parts of the help topic##'to#'Latest pkgdown site:DOCS.zip Might aid review.