{"action":"created","comment":{"url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/comments/220574046","pull_request_review_id":159010836,"id":220574046,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIyMDU3NDA0Ng==","diff_hunk":"@@ -43,17 +43,45 @@ def __repr__(self):\n \n @attr.s(slots=True)\n class Example(object):\n+    \"\"\"Examples track the hierarchical structure of draws from the byte stream.\n+\n+    An example usually corresponds to a single draw from a strategy, and\n+    includes that strategy's nested draws as children. There are also other\n+    kinds of examples, such as leaf examples that correspond to individual\n+    low-level blocks, and a single top-level example that spans the entire\n+    input.\n+\n+    Example-tracking allows the shrinker to try \"high-level\" transformations,\n+    such as rearranging or deleting the elements of a list, without having\n+    to understand their exact representation in the byte stream.\n+    \"\"\"\n+\n+    # Depth of this example in the example tree, which is equal to its number\n+    # of ancestor examples.","path":"hypothesis-python/src/hypothesis/internal/conjecture/data.py","position":18,"original_position":18,"commit_id":"7fb0462cf06a5c21cf6c9272689acf12ab136af0","original_commit_id":"7fb0462cf06a5c21cf6c9272689acf12ab136af0","user":{"login":"Zalathar","id":20290842,"node_id":"MDQ6VXNlcjIwMjkwODQy","avatar_url":"https://avatars0.githubusercontent.com/u/20290842?v=4","gravatar_id":"","url":"https://api.github.com/users/Zalathar","html_url":"https://github.com/Zalathar","followers_url":"https://api.github.com/users/Zalathar/followers","following_url":"https://api.github.com/users/Zalathar/following{/other_user}","gists_url":"https://api.github.com/users/Zalathar/gists{/gist_id}","starred_url":"https://api.github.com/users/Zalathar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Zalathar/subscriptions","organizations_url":"https://api.github.com/users/Zalathar/orgs","repos_url":"https://api.github.com/users/Zalathar/repos","events_url":"https://api.github.com/users/Zalathar/events{/privacy}","received_events_url":"https://api.github.com/users/Zalathar/received_events","type":"User","site_admin":false},"body":"The root example that spans the entire test run has a depth of 0.\r\n\r\nAnything that actually gets drawn will end up having a depth of at least 1. I believe the arguments to `@given` end up being packed into a tuple strategy, so the first \"user-facing\" draw should have a depth of at least 2, though I haven't confirmed this.\r\n\r\n(Explicitly listing the depth of the root example seems more useful than what I've currently written here.)","created_at":"2018-09-26T13:58:55Z","updated_at":"2018-09-26T13:58:56Z","html_url":"https://github.com/HypothesisWorks/hypothesis/pull/1601#discussion_r220574046","pull_request_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/comments/220574046"},"html":{"href":"https://github.com/HypothesisWorks/hypothesis/pull/1601#discussion_r220574046"},"pull_request":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601"}},"in_reply_to_id":220562937},"pull_request":{"url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601","id":218278981,"node_id":"MDExOlB1bGxSZXF1ZXN0MjE4Mjc4OTgx","html_url":"https://github.com/HypothesisWorks/hypothesis/pull/1601","diff_url":"https://github.com/HypothesisWorks/hypothesis/pull/1601.diff","patch_url":"https://github.com/HypothesisWorks/hypothesis/pull/1601.patch","issue_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues/1601","number":1601,"state":"open","locked":false,"title":"Add docstrings and comments for Example and Block","user":{"login":"Zalathar","id":20290842,"node_id":"MDQ6VXNlcjIwMjkwODQy","avatar_url":"https://avatars0.githubusercontent.com/u/20290842?v=4","gravatar_id":"","url":"https://api.github.com/users/Zalathar","html_url":"https://github.com/Zalathar","followers_url":"https://api.github.com/users/Zalathar/followers","following_url":"https://api.github.com/users/Zalathar/following{/other_user}","gists_url":"https://api.github.com/users/Zalathar/gists{/gist_id}","starred_url":"https://api.github.com/users/Zalathar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Zalathar/subscriptions","organizations_url":"https://api.github.com/users/Zalathar/orgs","repos_url":"https://api.github.com/users/Zalathar/repos","events_url":"https://api.github.com/users/Zalathar/events{/privacy}","received_events_url":"https://api.github.com/users/Zalathar/received_events","type":"User","site_admin":false},"body":"As suggested by https://github.com/HypothesisWorks/hypothesis/pull/1594#discussion_r219732109.\r\n\r\nLet me know if anything seems unclear or misleading.","created_at":"2018-09-26T11:22:24Z","updated_at":"2018-09-26T13:58:56Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d7a638ad0b81e4f64fd22004b6f9d7989c5d3976","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601/commits","review_comments_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601/comments","review_comment_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/comments{/number}","comments_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues/1601/comments","statuses_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/statuses/7fb0462cf06a5c21cf6c9272689acf12ab136af0","head":{"label":"Zalathar:example-block-docs","ref":"example-block-docs","sha":"7fb0462cf06a5c21cf6c9272689acf12ab136af0","user":{"login":"Zalathar","id":20290842,"node_id":"MDQ6VXNlcjIwMjkwODQy","avatar_url":"https://avatars0.githubusercontent.com/u/20290842?v=4","gravatar_id":"","url":"https://api.github.com/users/Zalathar","html_url":"https://github.com/Zalathar","followers_url":"https://api.github.com/users/Zalathar/followers","following_url":"https://api.github.com/users/Zalathar/following{/other_user}","gists_url":"https://api.github.com/users/Zalathar/gists{/gist_id}","starred_url":"https://api.github.com/users/Zalathar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Zalathar/subscriptions","organizations_url":"https://api.github.com/users/Zalathar/orgs","repos_url":"https://api.github.com/users/Zalathar/repos","events_url":"https://api.github.com/users/Zalathar/events{/privacy}","received_events_url":"https://api.github.com/users/Zalathar/received_events","type":"User","site_admin":false},"repo":{"id":144567011,"node_id":"MDEwOlJlcG9zaXRvcnkxNDQ1NjcwMTE=","name":"hypothesis","full_name":"Zalathar/hypothesis","private":false,"owner":{"login":"Zalathar","id":20290842,"node_id":"MDQ6VXNlcjIwMjkwODQy","avatar_url":"https://avatars0.githubusercontent.com/u/20290842?v=4","gravatar_id":"","url":"https://api.github.com/users/Zalathar","html_url":"https://github.com/Zalathar","followers_url":"https://api.github.com/users/Zalathar/followers","following_url":"https://api.github.com/users/Zalathar/following{/other_user}","gists_url":"https://api.github.com/users/Zalathar/gists{/gist_id}","starred_url":"https://api.github.com/users/Zalathar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Zalathar/subscriptions","organizations_url":"https://api.github.com/users/Zalathar/orgs","repos_url":"https://api.github.com/users/Zalathar/repos","events_url":"https://api.github.com/users/Zalathar/events{/privacy}","received_events_url":"https://api.github.com/users/Zalathar/received_events","type":"User","site_admin":false},"html_url":"https://github.com/Zalathar/hypothesis","description":"Hypothesis is a powerful, flexible, and easy to use library for property-based testing.","fork":true,"url":"https://api.github.com/repos/Zalathar/hypothesis","forks_url":"https://api.github.com/repos/Zalathar/hypothesis/forks","keys_url":"https://api.github.com/repos/Zalathar/hypothesis/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Zalathar/hypothesis/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Zalathar/hypothesis/teams","hooks_url":"https://api.github.com/repos/Zalathar/hypothesis/hooks","issue_events_url":"https://api.github.com/repos/Zalathar/hypothesis/issues/events{/number}","events_url":"https://api.github.com/repos/Zalathar/hypothesis/events","assignees_url":"https://api.github.com/repos/Zalathar/hypothesis/assignees{/user}","branches_url":"https://api.github.com/repos/Zalathar/hypothesis/branches{/branch}","tags_url":"https://api.github.com/repos/Zalathar/hypothesis/tags","blobs_url":"https://api.github.com/repos/Zalathar/hypothesis/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Zalathar/hypothesis/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Zalathar/hypothesis/git/refs{/sha}","trees_url":"https://api.github.com/repos/Zalathar/hypothesis/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Zalathar/hypothesis/statuses/{sha}","languages_url":"https://api.github.com/repos/Zalathar/hypothesis/languages","stargazers_url":"https://api.github.com/repos/Zalathar/hypothesis/stargazers","contributors_url":"https://api.github.com/repos/Zalathar/hypothesis/contributors","subscribers_url":"https://api.github.com/repos/Zalathar/hypothesis/subscribers","subscription_url":"https://api.github.com/repos/Zalathar/hypothesis/subscription","commits_url":"https://api.github.com/repos/Zalathar/hypothesis/commits{/sha}","git_commits_url":"https://api.github.com/repos/Zalathar/hypothesis/git/commits{/sha}","comments_url":"https://api.github.com/repos/Zalathar/hypothesis/comments{/number}","issue_comment_url":"https://api.github.com/repos/Zalathar/hypothesis/issues/comments{/number}","contents_url":"https://api.github.com/repos/Zalathar/hypothesis/contents/{+path}","compare_url":"https://api.github.com/repos/Zalathar/hypothesis/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Zalathar/hypothesis/merges","archive_url":"https://api.github.com/repos/Zalathar/hypothesis/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Zalathar/hypothesis/downloads","issues_url":"https://api.github.com/repos/Zalathar/hypothesis/issues{/number}","pulls_url":"https://api.github.com/repos/Zalathar/hypothesis/pulls{/number}","milestones_url":"https://api.github.com/repos/Zalathar/hypothesis/milestones{/number}","notifications_url":"https://api.github.com/repos/Zalathar/hypothesis/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Zalathar/hypothesis/labels{/name}","releases_url":"https://api.github.com/repos/Zalathar/hypothesis/releases{/id}","deployments_url":"https://api.github.com/repos/Zalathar/hypothesis/deployments","created_at":"2018-08-13T10:52:36Z","updated_at":"2018-09-26T03:44:57Z","pushed_at":"2018-09-26T11:32:26Z","git_url":"git://github.com/Zalathar/hypothesis.git","ssh_url":"git@github.com:Zalathar/hypothesis.git","clone_url":"https://github.com/Zalathar/hypothesis.git","svn_url":"https://github.com/Zalathar/hypothesis","homepage":"http://hypothesis.works","size":12841,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"other","name":"Other","spdx_id":null,"url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"HypothesisWorks:master","ref":"master","sha":"f2bfb12114c0ee69504d0633265f4a642b75710e","user":{"login":"HypothesisWorks","id":18481919,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE4NDgxOTE5","avatar_url":"https://avatars1.githubusercontent.com/u/18481919?v=4","gravatar_id":"","url":"https://api.github.com/users/HypothesisWorks","html_url":"https://github.com/HypothesisWorks","followers_url":"https://api.github.com/users/HypothesisWorks/followers","following_url":"https://api.github.com/users/HypothesisWorks/following{/other_user}","gists_url":"https://api.github.com/users/HypothesisWorks/gists{/gist_id}","starred_url":"https://api.github.com/users/HypothesisWorks/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/HypothesisWorks/subscriptions","organizations_url":"https://api.github.com/users/HypothesisWorks/orgs","repos_url":"https://api.github.com/users/HypothesisWorks/repos","events_url":"https://api.github.com/users/HypothesisWorks/events{/privacy}","received_events_url":"https://api.github.com/users/HypothesisWorks/received_events","type":"Organization","site_admin":false},"repo":{"id":8685799,"node_id":"MDEwOlJlcG9zaXRvcnk4Njg1Nzk5","name":"hypothesis","full_name":"HypothesisWorks/hypothesis","private":false,"owner":{"login":"HypothesisWorks","id":18481919,"node_id":"MDEyOk9yZ2FuaXphdGlvbjE4NDgxOTE5","avatar_url":"https://avatars1.githubusercontent.com/u/18481919?v=4","gravatar_id":"","url":"https://api.github.com/users/HypothesisWorks","html_url":"https://github.com/HypothesisWorks","followers_url":"https://api.github.com/users/HypothesisWorks/followers","following_url":"https://api.github.com/users/HypothesisWorks/following{/other_user}","gists_url":"https://api.github.com/users/HypothesisWorks/gists{/gist_id}","starred_url":"https://api.github.com/users/HypothesisWorks/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/HypothesisWorks/subscriptions","organizations_url":"https://api.github.com/users/HypothesisWorks/orgs","repos_url":"https://api.github.com/users/HypothesisWorks/repos","events_url":"https://api.github.com/users/HypothesisWorks/events{/privacy}","received_events_url":"https://api.github.com/users/HypothesisWorks/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/HypothesisWorks/hypothesis","description":"Hypothesis is a powerful, flexible, and easy to use library for property-based testing.","fork":false,"url":"https://api.github.com/repos/HypothesisWorks/hypothesis","forks_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/forks","keys_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/keys{/key_id}","collaborators_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/teams","hooks_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/hooks","issue_events_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues/events{/number}","events_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/events","assignees_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/assignees{/user}","branches_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/branches{/branch}","tags_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/tags","blobs_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/git/refs{/sha}","trees_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/git/trees{/sha}","statuses_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/statuses/{sha}","languages_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/languages","stargazers_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/stargazers","contributors_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/contributors","subscribers_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/subscribers","subscription_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/subscription","commits_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/commits{/sha}","git_commits_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/git/commits{/sha}","comments_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/comments{/number}","issue_comment_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues/comments{/number}","contents_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/contents/{+path}","compare_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/compare/{base}...{head}","merges_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/merges","archive_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/downloads","issues_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues{/number}","pulls_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls{/number}","milestones_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/milestones{/number}","notifications_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/labels{/name}","releases_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/releases{/id}","deployments_url":"https://api.github.com/repos/HypothesisWorks/hypothesis/deployments","created_at":"2013-03-10T13:51:19Z","updated_at":"2018-09-26T13:45:08Z","pushed_at":"2018-09-26T13:43:53Z","git_url":"git://github.com/HypothesisWorks/hypothesis.git","ssh_url":"git@github.com:HypothesisWorks/hypothesis.git","clone_url":"https://github.com/HypothesisWorks/hypothesis.git","svn_url":"https://github.com/HypothesisWorks/hypothesis","homepage":"http://hypothesis.works","size":13272,"stargazers_count":2956,"watchers_count":2956,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":269,"mirror_url":null,"archived":false,"open_issues_count":83,"license":{"key":"other","name":"Other","spdx_id":null,"url":null,"node_id":"MDc6TGljZW5zZTA="},"forks":269,"open_issues":83,"watchers":2956,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601"},"html":{"href":"https://github.com/HypothesisWorks/hypothesis/pull/1601"},"issue":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues/1601"},"comments":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/issues/1601/comments"},"review_comments":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601/comments"},"review_comment":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/pulls/1601/commits"},"statuses":{"href":"https://api.github.com/repos/HypothesisWorks/hypothesis/statuses/7fb0462cf06a5c21cf6c9272689acf12ab136af0"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"Zalathar"}}