This is for comment clean-up.
Need to make sure the following are done:
- Remove REDUNDANT documentation comments between the
.R files in the R folder and the .Rd files in the man folder. Most comments for USER facing functions should be reserved for the R documentation.
- Note that we are not using
roxygen at all for lme4. Hence, having 'proper' roxygen formatting actually runs the risk of accidentally overwriting the ?modular documentation at some point. So, ensure that there are no roxygen comments that can be used to overrun.
- Let's keep relevant
roxygen comments used to help explain some of the documentation of the internal functions (i.e., things in utilities). One quick check is that if the function doesn't have a dedicated .Rd file in the man folder, it's likely an internal function and can be left alone (except for again, making sure it's not too proper so nothing gets completely overrun by accident.)
This is for comment clean-up.
Need to make sure the following are done:
.Rfiles in theRfolder and the.Rdfiles in themanfolder. Most comments for USER facing functions should be reserved for theRdocumentation.roxygenat all forlme4. Hence, having 'proper'roxygenformatting actually runs the risk of accidentally overwriting the?modulardocumentation at some point. So, ensure that there are noroxygencomments that can be used to overrun.roxygencomments used to help explain some of the documentation of the internal functions (i.e., things in utilities). One quick check is that if the function doesn't have a dedicated.Rdfile in themanfolder, it's likely an internal function and can be left alone (except for again, making sure it's not too proper so nothing gets completely overrun by accident.)