r-devel
Mention tools::checkRd in documentation chapter
Add this function to documentation chapter -it picks up missing brackets, non ASCII characters (share examples about it - does not work vs works)
@EllaKaye @SaranjeetKaur @hturner could you please review that pull, and reply if any changes..
Aside: I just wrote some code consuming the output of tools::checkRd() and was puzzled to learn that it just returns a classed string like checkRd: (%d) %s.
It seems to me that a data structure like list(line_number, finding) would be more useful instead of relying on string parsing.
We can see that print.checkRd() does just such string parsing:
https://github.com/r-devel/r-svn/blob/a2fb5899d5d7a8d21dfbfb4f710f70672784e672/src/library/tools/R/RdConv2.R#L1160-L1169
(writing here as a little more than a note-to-self prior to making it an r-devel post)
Thank you @MichaelChirico sir, for your feedback and for confirming that my observation is valid. I appreciate your suggestion to post this on the r-devel mailing list, and I’ll share my idea there for broader discussion. If you have any tips for framing the post or additional context I should include, please let me know. Thanks again!