{"action":"opened","issue":{"url":"https://api.github.com/repos/yannickcr/eslint-plugin-react/issues/1900","repository_url":"https://api.github.com/repos/yannickcr/eslint-plugin-react","labels_url":"https://api.github.com/repos/yannickcr/eslint-plugin-react/issues/1900/labels{/name}","comments_url":"https://api.github.com/repos/yannickcr/eslint-plugin-react/issues/1900/comments","events_url":"https://api.github.com/repos/yannickcr/eslint-plugin-react/issues/1900/events","html_url":"https://github.com/yannickcr/eslint-plugin-react/issues/1900","id":344547883,"node_id":"MDU6SXNzdWUzNDQ1NDc4ODM=","number":1900,"title":"Rule proposal: comments on propTypes","user":{"login":"alexzherdev","id":93752,"node_id":"MDQ6VXNlcjkzNzUy","avatar_url":"https://avatars3.githubusercontent.com/u/93752?v=4","gravatar_id":"","url":"https://api.github.com/users/alexzherdev","html_url":"https://github.com/alexzherdev","followers_url":"https://api.github.com/users/alexzherdev/followers","following_url":"https://api.github.com/users/alexzherdev/following{/other_user}","gists_url":"https://api.github.com/users/alexzherdev/gists{/gist_id}","starred_url":"https://api.github.com/users/alexzherdev/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alexzherdev/subscriptions","organizations_url":"https://api.github.com/users/alexzherdev/orgs","repos_url":"https://api.github.com/users/alexzherdev/repos","events_url":"https://api.github.com/users/alexzherdev/events{/privacy}","received_events_url":"https://api.github.com/users/alexzherdev/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-07-25T18:02:17Z","updated_at":"2018-07-25T18:02:17Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"When using tools like [react-docgen](https://github.com/reactjs/react-docgen) (or those based on it like [@storybook/addon-info](https://github.com/storybooks/storybook/tree/master/addons/info)) it is expected that each propType declaration has a comment with a description e.g.\r\n```js\r\nMyComponent.propTypes = {\r\n  /**\r\n   * Description of prop \"foo\".\r\n   */\r\n  foo: PropTypes.number\r\n}\r\n```\r\nIf the comment is not there, then the generated documentation is not complete/meaningful.\r\n\r\nWould a rule that reminds developers of this be useful to have in the plugin, or is this too specific/special-case?"}}
{"actor":{"display_login":"alexzherdev"}}