{"action":"opened","issue":{"url":"https://api.github.com/repos/Bioconductor/BiocCheck/issues/19","repository_url":"https://api.github.com/repos/Bioconductor/BiocCheck","labels_url":"https://api.github.com/repos/Bioconductor/BiocCheck/issues/19/labels{/name}","comments_url":"https://api.github.com/repos/Bioconductor/BiocCheck/issues/19/comments","events_url":"https://api.github.com/repos/Bioconductor/BiocCheck/issues/19/events","html_url":"https://github.com/Bioconductor/BiocCheck/issues/19","id":257745808,"number":19,"title":"WARNING with empty/missing \\value section in man pages describing data sets","user":{"login":"aoles","id":6545356,"avatar_url":"https://avatars2.githubusercontent.com/u/6545356?v=4","gravatar_id":"","url":"https://api.github.com/users/aoles","html_url":"https://github.com/aoles","followers_url":"https://api.github.com/users/aoles/followers","following_url":"https://api.github.com/users/aoles/following{/other_user}","gists_url":"https://api.github.com/users/aoles/gists{/gist_id}","starred_url":"https://api.github.com/users/aoles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aoles/subscriptions","organizations_url":"https://api.github.com/users/aoles/orgs","repos_url":"https://api.github.com/users/aoles/repos","events_url":"https://api.github.com/users/aoles/events{/privacy}","received_events_url":"https://api.github.com/users/aoles/received_events","type":"User","site_admin":false},"labels":[{"id":221013088,"url":"https://api.github.com/repos/Bioconductor/BiocCheck/labels/bug","name":"bug","color":"fc2929","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-09-14T14:44:00Z","updated_at":"2017-09-14T14:44:00Z","closed_at":null,"author_association":"NONE","body":"A warning is issued for a man page describing data objects when it doesn't contain a non-empty \\value section.\r\n```\r\n* Checking man pages...\r\n    * WARNING: Add non-empty \\value sections to the following man\r\n      pages: ...\r\n```\r\nAccording to \"Writing R Extensions\" [Section 2.1.2 *Documenting data sets*](https://cran.r-project.org/doc/manuals/r-release/R-exts.html#Documenting-data-sets):\r\n\r\n>The structure of Rd files which document R data sets is slightly different. Sections such as \\arguments and \\value are not needed but the format and source of the data should be explained.\r\n\r\nTherefore, a \\value section on a data man page shouldn't be enforced. In fact, even the template produced by a call to `package.skeleton` doesn't include this section.\r\n\r\nData sets man pages can be told apart from other man pages based on the \\keyword entry which for data sets should always be 'datasets'. "}}
{"actor":{"display_login":"aoles"}}