{"action":"created","issue":{"url":"https://api.github.com/repos/eslint/eslint/issues/5446","repository_url":"https://api.github.com/repos/eslint/eslint","labels_url":"https://api.github.com/repos/eslint/eslint/issues/5446/labels{/name}","comments_url":"https://api.github.com/repos/eslint/eslint/issues/5446/comments","events_url":"https://api.github.com/repos/eslint/eslint/issues/5446/events","html_url":"https://github.com/eslint/eslint/issues/5446","id":137636379,"number":5446,"title":"Docs: WIP Guidelines for rule pages","user":{"login":"pedrottimark","id":11862657,"avatar_url":"https://avatars.githubusercontent.com/u/11862657?v=3","gravatar_id":"","url":"https://api.github.com/users/pedrottimark","html_url":"https://github.com/pedrottimark","followers_url":"https://api.github.com/users/pedrottimark/followers","following_url":"https://api.github.com/users/pedrottimark/following{/other_user}","gists_url":"https://api.github.com/users/pedrottimark/gists{/gist_id}","starred_url":"https://api.github.com/users/pedrottimark/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pedrottimark/subscriptions","organizations_url":"https://api.github.com/users/pedrottimark/orgs","repos_url":"https://api.github.com/users/pedrottimark/repos","events_url":"https://api.github.com/users/pedrottimark/events{/privacy}","received_events_url":"https://api.github.com/users/pedrottimark/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/eslint/eslint/labels/accepted","name":"accepted","color":"0052cc"},{"url":"https://api.github.com/repos/eslint/eslint/labels/documentation","name":"documentation","color":"5319e7"},{"url":"https://api.github.com/repos/eslint/eslint/labels/rule","name":"rule","color":"fbca04"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-03-01T17:23:58Z","updated_at":"2016-03-02T16:03:55Z","closed_at":null,"body":"This issue will accumulate the **reusable patterns** that emerge while the rules pages are edited to improve consistency. The result will become a **template and guidelines** (in a format yet to be determined) for future editing, especially new options and rules.\r\n\r\nGoals: https://github.com/eslint/eslint.github.io/issues/186#issuecomment-176457525, https://github.com/eslint/eslint.github.io/issues/186#issuecomment-176457525, https://github.com/eslint/eslint/pull/5375#issuecomment-187488216\r\n\r\nPull requests will have often discussion about specific occurrences which sometimes cause us to add generalized conclusions to this issue. This issue can also have questions, concerns, suggestions."},"comment":{"url":"https://api.github.com/repos/eslint/eslint/issues/comments/191303145","html_url":"https://github.com/eslint/eslint/issues/5446#issuecomment-191303145","issue_url":"https://api.github.com/repos/eslint/eslint/issues/5446","id":191303145,"user":{"login":"pedrottimark","id":11862657,"avatar_url":"https://avatars.githubusercontent.com/u/11862657?v=3","gravatar_id":"","url":"https://api.github.com/users/pedrottimark","html_url":"https://github.com/pedrottimark","followers_url":"https://api.github.com/users/pedrottimark/followers","following_url":"https://api.github.com/users/pedrottimark/following{/other_user}","gists_url":"https://api.github.com/users/pedrottimark/gists{/gist_id}","starred_url":"https://api.github.com/users/pedrottimark/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pedrottimark/subscriptions","organizations_url":"https://api.github.com/users/pedrottimark/orgs","repos_url":"https://api.github.com/users/pedrottimark/repos","events_url":"https://api.github.com/users/pedrottimark/events{/privacy}","received_events_url":"https://api.github.com/users/pedrottimark/received_events","type":"User","site_admin":false},"created_at":"2016-03-02T16:03:54Z","updated_at":"2016-03-02T16:03:54Z","body":"If a rule page has a **level-2 Options** heading, then for each option which has examples there is a **level-3** heading.\r\n\r\nThe heading text is either:\r\n* string value (for example, always, never)\r\n* object key (for example, after, before, hoist)\r\n\r\nFor faster scanning, there is **no** additional punctuation (quotes) or formatting (code style indicated by backticks). The example sentences and eslint comments in the code specify the required syntax.\r\n\r\nIf there are separate examples for values of an object property, then there are **level-4** headings. A **colon** separates key from value, for example:\r\nhoist: functions\r\nhoist: all\r\nhoist: never\r\n"}}