Bioconductor / BiocCheck

http://bioconductor.org/packages/BiocCheck
8 stars 26 forks source link

False positive checking for value section in Rd files #189

Closed grimbough closed 1 year ago

grimbough commented 1 year ago

Hi @LiNk-NY

I think the recent changes for checking return sections in Rd files might be triggering a false positive. Specifically I'm thinking of man pages that document the package itself, which I wouldn't expect to have a return section.

These are described in r-pkgs.org and I have a specific example in Rarr which is now triggering a warning in BiocCheck when it did not in the past.

If you agree it's a false positive, I wonder if you can use BiocCheck:::docType(rd) == "package" somewhere to test for this scenario.

Cheers, Mike

LiNk-NY commented 1 year ago

Thanks for reporting. It should be resolved in ad4d1c88117d0ad808d12a6935b095de703cd859

grimbough commented 1 year ago

Awesome, thanks a lot!