{"action":"created","comment":{"url":"https://api.github.com/repos/frontrowed/guides/pulls/comments/195747957","pull_request_review_id":129179510,"id":195747957,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDE5NTc0Nzk1Nw==","diff_hunk":"@@ -660,3 +660,329 @@ module Driver\n     ) where\n \n   ```\n+\n+## Haddocks\n+\n+Haskell modules should be commented with valid Haddock documentation. We are not\n+yet requiring a certain level of coverage, but it is strongly encouraged.\n+\n+### General guides\n+\n+- Use proper Haddock [markup][]\n+- Link all identifiers, anywhere they appear\n+\n+  Bad\n+\n+  ```hs\n+  -- | Construct a @'FlipFlop'@\n+  --\n+  -- If the size is right, you will get a @Right FlipFlop@, otherwise a @Left@\n+  --\n+  ```\n+\n+  Good\n+\n+  ```hs\n+  -- | Construct a @'FlipFlop'@\n+  --\n+  -- If the size is right, you will get a @'Right' 'FlipFlop'@, otherwise a\n+  -- @'Left'@.\n+  --\n+  ```\n+\n+- Use leading documentation (`-- |`) for top-level definitions and trailing\n+  documentation (`-- ^`) for record attributes and function arguments\n+\n+  Bad\n+\n+  ```hs\n+  data Foo = Foo\n+    {\n+    -- | Foo's foo\n+      fooFoo :: Foo\n+    -- | Foo's bar\n+    , fooBar :: Bar\n+    }\n+  -- ^ What even is a Foo?\n+  ```\n+\n+  Good\n+\n+  ```hs\n+  -- | What even is a Foo?\n+  data Foo = Foo","path":"haskell-style.md","position":54,"original_position":54,"commit_id":"52f3b3131e63c35a441e0df4007db9cfe38106cf","original_commit_id":"52f3b3131e63c35a441e0df4007db9cfe38106cf","user":{"login":"eborden","id":545655,"node_id":"MDQ6VXNlcjU0NTY1NQ==","avatar_url":"https://avatars2.githubusercontent.com/u/545655?v=4","gravatar_id":"","url":"https://api.github.com/users/eborden","html_url":"https://github.com/eborden","followers_url":"https://api.github.com/users/eborden/followers","following_url":"https://api.github.com/users/eborden/following{/other_user}","gists_url":"https://api.github.com/users/eborden/gists{/gist_id}","starred_url":"https://api.github.com/users/eborden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eborden/subscriptions","organizations_url":"https://api.github.com/users/eborden/orgs","repos_url":"https://api.github.com/users/eborden/repos","events_url":"https://api.github.com/users/eborden/events{/privacy}","received_events_url":"https://api.github.com/users/eborden/received_events","type":"User","site_admin":false},"body":"It seems @pbrisbin is following the `brittany` style here (rather the proposed style, since that branch is still in dev).","created_at":"2018-06-15T14:12:26Z","updated_at":"2018-06-15T14:12:27Z","html_url":"https://github.com/frontrowed/guides/pull/21#discussion_r195747957","pull_request_url":"https://api.github.com/repos/frontrowed/guides/pulls/21","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/frontrowed/guides/pulls/comments/195747957"},"html":{"href":"https://github.com/frontrowed/guides/pull/21#discussion_r195747957"},"pull_request":{"href":"https://api.github.com/repos/frontrowed/guides/pulls/21"}},"in_reply_to_id":195744332},"pull_request":{"url":"https://api.github.com/repos/frontrowed/guides/pulls/21","id":195151020,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk1MTUxMDIw","html_url":"https://github.com/frontrowed/guides/pull/21","diff_url":"https://github.com/frontrowed/guides/pull/21.diff","patch_url":"https://github.com/frontrowed/guides/pull/21.patch","issue_url":"https://api.github.com/repos/frontrowed/guides/issues/21","number":21,"state":"open","locked":false,"title":"Describe preferred Haddock formatting style","user":{"login":"pbrisbin","id":50812,"node_id":"MDQ6VXNlcjUwODEy","avatar_url":"https://avatars3.githubusercontent.com/u/50812?v=4","gravatar_id":"","url":"https://api.github.com/users/pbrisbin","html_url":"https://github.com/pbrisbin","followers_url":"https://api.github.com/users/pbrisbin/followers","following_url":"https://api.github.com/users/pbrisbin/following{/other_user}","gists_url":"https://api.github.com/users/pbrisbin/gists{/gist_id}","starred_url":"https://api.github.com/users/pbrisbin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pbrisbin/subscriptions","organizations_url":"https://api.github.com/users/pbrisbin/orgs","repos_url":"https://api.github.com/users/pbrisbin/repos","events_url":"https://api.github.com/users/pbrisbin/events{/privacy}","received_events_url":"https://api.github.com/users/pbrisbin/received_events","type":"User","site_admin":false},"body":null,"created_at":"2018-06-15T11:44:59Z","updated_at":"2018-06-15T14:12:27Z","closed_at":null,"merged_at":null,"merge_commit_sha":"f3314c84f048242c6c44e130bb62a04313d9eb00","assignee":null,"assignees":[],"requested_reviewers":[{"login":"5outh","id":959901,"node_id":"MDQ6VXNlcjk1OTkwMQ==","avatar_url":"https://avatars2.githubusercontent.com/u/959901?v=4","gravatar_id":"","url":"https://api.github.com/users/5outh","html_url":"https://github.com/5outh","followers_url":"https://api.github.com/users/5outh/followers","following_url":"https://api.github.com/users/5outh/following{/other_user}","gists_url":"https://api.github.com/users/5outh/gists{/gist_id}","starred_url":"https://api.github.com/users/5outh/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/5outh/subscriptions","organizations_url":"https://api.github.com/users/5outh/orgs","repos_url":"https://api.github.com/users/5outh/repos","events_url":"https://api.github.com/users/5outh/events{/privacy}","received_events_url":"https://api.github.com/users/5outh/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/frontrowed/guides/pulls/21/commits","review_comments_url":"https://api.github.com/repos/frontrowed/guides/pulls/21/comments","review_comment_url":"https://api.github.com/repos/frontrowed/guides/pulls/comments{/number}","comments_url":"https://api.github.com/repos/frontrowed/guides/issues/21/comments","statuses_url":"https://api.github.com/repos/frontrowed/guides/statuses/52f3b3131e63c35a441e0df4007db9cfe38106cf","head":{"label":"frontrowed:pb/haddock","ref":"pb/haddock","sha":"52f3b3131e63c35a441e0df4007db9cfe38106cf","user":{"login":"frontrowed","id":8933560,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg5MzM1NjA=","avatar_url":"https://avatars0.githubusercontent.com/u/8933560?v=4","gravatar_id":"","url":"https://api.github.com/users/frontrowed","html_url":"https://github.com/frontrowed","followers_url":"https://api.github.com/users/frontrowed/followers","following_url":"https://api.github.com/users/frontrowed/following{/other_user}","gists_url":"https://api.github.com/users/frontrowed/gists{/gist_id}","starred_url":"https://api.github.com/users/frontrowed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/frontrowed/subscriptions","organizations_url":"https://api.github.com/users/frontrowed/orgs","repos_url":"https://api.github.com/users/frontrowed/repos","events_url":"https://api.github.com/users/frontrowed/events{/privacy}","received_events_url":"https://api.github.com/users/frontrowed/received_events","type":"Organization","site_admin":false},"repo":{"id":52305575,"node_id":"MDEwOlJlcG9zaXRvcnk1MjMwNTU3NQ==","name":"guides","full_name":"frontrowed/guides","owner":{"login":"frontrowed","id":8933560,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg5MzM1NjA=","avatar_url":"https://avatars0.githubusercontent.com/u/8933560?v=4","gravatar_id":"","url":"https://api.github.com/users/frontrowed","html_url":"https://github.com/frontrowed","followers_url":"https://api.github.com/users/frontrowed/followers","following_url":"https://api.github.com/users/frontrowed/following{/other_user}","gists_url":"https://api.github.com/users/frontrowed/gists{/gist_id}","starred_url":"https://api.github.com/users/frontrowed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/frontrowed/subscriptions","organizations_url":"https://api.github.com/users/frontrowed/orgs","repos_url":"https://api.github.com/users/frontrowed/repos","events_url":"https://api.github.com/users/frontrowed/events{/privacy}","received_events_url":"https://api.github.com/users/frontrowed/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/frontrowed/guides","description":"Front Row guides and best practices","fork":false,"url":"https://api.github.com/repos/frontrowed/guides","forks_url":"https://api.github.com/repos/frontrowed/guides/forks","keys_url":"https://api.github.com/repos/frontrowed/guides/keys{/key_id}","collaborators_url":"https://api.github.com/repos/frontrowed/guides/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/frontrowed/guides/teams","hooks_url":"https://api.github.com/repos/frontrowed/guides/hooks","issue_events_url":"https://api.github.com/repos/frontrowed/guides/issues/events{/number}","events_url":"https://api.github.com/repos/frontrowed/guides/events","assignees_url":"https://api.github.com/repos/frontrowed/guides/assignees{/user}","branches_url":"https://api.github.com/repos/frontrowed/guides/branches{/branch}","tags_url":"https://api.github.com/repos/frontrowed/guides/tags","blobs_url":"https://api.github.com/repos/frontrowed/guides/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/frontrowed/guides/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/frontrowed/guides/git/refs{/sha}","trees_url":"https://api.github.com/repos/frontrowed/guides/git/trees{/sha}","statuses_url":"https://api.github.com/repos/frontrowed/guides/statuses/{sha}","languages_url":"https://api.github.com/repos/frontrowed/guides/languages","stargazers_url":"https://api.github.com/repos/frontrowed/guides/stargazers","contributors_url":"https://api.github.com/repos/frontrowed/guides/contributors","subscribers_url":"https://api.github.com/repos/frontrowed/guides/subscribers","subscription_url":"https://api.github.com/repos/frontrowed/guides/subscription","commits_url":"https://api.github.com/repos/frontrowed/guides/commits{/sha}","git_commits_url":"https://api.github.com/repos/frontrowed/guides/git/commits{/sha}","comments_url":"https://api.github.com/repos/frontrowed/guides/comments{/number}","issue_comment_url":"https://api.github.com/repos/frontrowed/guides/issues/comments{/number}","contents_url":"https://api.github.com/repos/frontrowed/guides/contents/{+path}","compare_url":"https://api.github.com/repos/frontrowed/guides/compare/{base}...{head}","merges_url":"https://api.github.com/repos/frontrowed/guides/merges","archive_url":"https://api.github.com/repos/frontrowed/guides/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/frontrowed/guides/downloads","issues_url":"https://api.github.com/repos/frontrowed/guides/issues{/number}","pulls_url":"https://api.github.com/repos/frontrowed/guides/pulls{/number}","milestones_url":"https://api.github.com/repos/frontrowed/guides/milestones{/number}","notifications_url":"https://api.github.com/repos/frontrowed/guides/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/frontrowed/guides/labels{/name}","releases_url":"https://api.github.com/repos/frontrowed/guides/releases{/id}","deployments_url":"https://api.github.com/repos/frontrowed/guides/deployments","created_at":"2016-02-22T21:02:43Z","updated_at":"2018-06-07T13:56:13Z","pushed_at":"2018-06-15T11:45:00Z","git_url":"git://github.com/frontrowed/guides.git","ssh_url":"git@github.com:frontrowed/guides.git","clone_url":"https://github.com/frontrowed/guides.git","svn_url":"https://github.com/frontrowed/guides","homepage":null,"size":62,"stargazers_count":15,"watchers_count":15,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"archived":false,"open_issues_count":2,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":3,"open_issues":2,"watchers":15,"default_branch":"master"}},"base":{"label":"frontrowed:master","ref":"master","sha":"7fcf22ef0567f18f7fa739ec0d83cd9789938d90","user":{"login":"frontrowed","id":8933560,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg5MzM1NjA=","avatar_url":"https://avatars0.githubusercontent.com/u/8933560?v=4","gravatar_id":"","url":"https://api.github.com/users/frontrowed","html_url":"https://github.com/frontrowed","followers_url":"https://api.github.com/users/frontrowed/followers","following_url":"https://api.github.com/users/frontrowed/following{/other_user}","gists_url":"https://api.github.com/users/frontrowed/gists{/gist_id}","starred_url":"https://api.github.com/users/frontrowed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/frontrowed/subscriptions","organizations_url":"https://api.github.com/users/frontrowed/orgs","repos_url":"https://api.github.com/users/frontrowed/repos","events_url":"https://api.github.com/users/frontrowed/events{/privacy}","received_events_url":"https://api.github.com/users/frontrowed/received_events","type":"Organization","site_admin":false},"repo":{"id":52305575,"node_id":"MDEwOlJlcG9zaXRvcnk1MjMwNTU3NQ==","name":"guides","full_name":"frontrowed/guides","owner":{"login":"frontrowed","id":8933560,"node_id":"MDEyOk9yZ2FuaXphdGlvbjg5MzM1NjA=","avatar_url":"https://avatars0.githubusercontent.com/u/8933560?v=4","gravatar_id":"","url":"https://api.github.com/users/frontrowed","html_url":"https://github.com/frontrowed","followers_url":"https://api.github.com/users/frontrowed/followers","following_url":"https://api.github.com/users/frontrowed/following{/other_user}","gists_url":"https://api.github.com/users/frontrowed/gists{/gist_id}","starred_url":"https://api.github.com/users/frontrowed/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/frontrowed/subscriptions","organizations_url":"https://api.github.com/users/frontrowed/orgs","repos_url":"https://api.github.com/users/frontrowed/repos","events_url":"https://api.github.com/users/frontrowed/events{/privacy}","received_events_url":"https://api.github.com/users/frontrowed/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/frontrowed/guides","description":"Front Row guides and best practices","fork":false,"url":"https://api.github.com/repos/frontrowed/guides","forks_url":"https://api.github.com/repos/frontrowed/guides/forks","keys_url":"https://api.github.com/repos/frontrowed/guides/keys{/key_id}","collaborators_url":"https://api.github.com/repos/frontrowed/guides/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/frontrowed/guides/teams","hooks_url":"https://api.github.com/repos/frontrowed/guides/hooks","issue_events_url":"https://api.github.com/repos/frontrowed/guides/issues/events{/number}","events_url":"https://api.github.com/repos/frontrowed/guides/events","assignees_url":"https://api.github.com/repos/frontrowed/guides/assignees{/user}","branches_url":"https://api.github.com/repos/frontrowed/guides/branches{/branch}","tags_url":"https://api.github.com/repos/frontrowed/guides/tags","blobs_url":"https://api.github.com/repos/frontrowed/guides/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/frontrowed/guides/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/frontrowed/guides/git/refs{/sha}","trees_url":"https://api.github.com/repos/frontrowed/guides/git/trees{/sha}","statuses_url":"https://api.github.com/repos/frontrowed/guides/statuses/{sha}","languages_url":"https://api.github.com/repos/frontrowed/guides/languages","stargazers_url":"https://api.github.com/repos/frontrowed/guides/stargazers","contributors_url":"https://api.github.com/repos/frontrowed/guides/contributors","subscribers_url":"https://api.github.com/repos/frontrowed/guides/subscribers","subscription_url":"https://api.github.com/repos/frontrowed/guides/subscription","commits_url":"https://api.github.com/repos/frontrowed/guides/commits{/sha}","git_commits_url":"https://api.github.com/repos/frontrowed/guides/git/commits{/sha}","comments_url":"https://api.github.com/repos/frontrowed/guides/comments{/number}","issue_comment_url":"https://api.github.com/repos/frontrowed/guides/issues/comments{/number}","contents_url":"https://api.github.com/repos/frontrowed/guides/contents/{+path}","compare_url":"https://api.github.com/repos/frontrowed/guides/compare/{base}...{head}","merges_url":"https://api.github.com/repos/frontrowed/guides/merges","archive_url":"https://api.github.com/repos/frontrowed/guides/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/frontrowed/guides/downloads","issues_url":"https://api.github.com/repos/frontrowed/guides/issues{/number}","pulls_url":"https://api.github.com/repos/frontrowed/guides/pulls{/number}","milestones_url":"https://api.github.com/repos/frontrowed/guides/milestones{/number}","notifications_url":"https://api.github.com/repos/frontrowed/guides/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/frontrowed/guides/labels{/name}","releases_url":"https://api.github.com/repos/frontrowed/guides/releases{/id}","deployments_url":"https://api.github.com/repos/frontrowed/guides/deployments","created_at":"2016-02-22T21:02:43Z","updated_at":"2018-06-07T13:56:13Z","pushed_at":"2018-06-15T11:45:00Z","git_url":"git://github.com/frontrowed/guides.git","ssh_url":"git@github.com:frontrowed/guides.git","clone_url":"https://github.com/frontrowed/guides.git","svn_url":"https://github.com/frontrowed/guides","homepage":null,"size":62,"stargazers_count":15,"watchers_count":15,"language":null,"has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"archived":false,"open_issues_count":2,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":3,"open_issues":2,"watchers":15,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/frontrowed/guides/pulls/21"},"html":{"href":"https://github.com/frontrowed/guides/pull/21"},"issue":{"href":"https://api.github.com/repos/frontrowed/guides/issues/21"},"comments":{"href":"https://api.github.com/repos/frontrowed/guides/issues/21/comments"},"review_comments":{"href":"https://api.github.com/repos/frontrowed/guides/pulls/21/comments"},"review_comment":{"href":"https://api.github.com/repos/frontrowed/guides/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/frontrowed/guides/pulls/21/commits"},"statuses":{"href":"https://api.github.com/repos/frontrowed/guides/statuses/52f3b3131e63c35a441e0df4007db9cfe38106cf"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"eborden"}}