{"action":"closed","number":309,"pull_request":{"url":"https://api.github.com/repos/PyWavelets/pywt/pulls/309","id":115164950,"html_url":"https://github.com/PyWavelets/pywt/pull/309","diff_url":"https://github.com/PyWavelets/pywt/pull/309.diff","patch_url":"https://github.com/PyWavelets/pywt/pull/309.patch","issue_url":"https://api.github.com/repos/PyWavelets/pywt/issues/309","number":309,"state":"closed","locked":false,"title":"Document how max levels are determined for multilevel DWT and SWT routines.","user":{"login":"grlee77","id":6528957,"avatar_url":"https://avatars3.githubusercontent.com/u/6528957?v=4","gravatar_id":"","url":"https://api.github.com/users/grlee77","html_url":"https://github.com/grlee77","followers_url":"https://api.github.com/users/grlee77/followers","following_url":"https://api.github.com/users/grlee77/following{/other_user}","gists_url":"https://api.github.com/users/grlee77/gists{/gist_id}","starred_url":"https://api.github.com/users/grlee77/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/grlee77/subscriptions","organizations_url":"https://api.github.com/users/grlee77/orgs","repos_url":"https://api.github.com/users/grlee77/repos","events_url":"https://api.github.com/users/grlee77/events{/privacy}","received_events_url":"https://api.github.com/users/grlee77/received_events","type":"User","site_admin":false},"body":"This PR improves the `dwt_max_levels` docstring as discussed in #306\r\n\r\nThanks to @JohnLunzer for the suggested improvement to the phrasing used here.\r\n\r\nI opted to enable the MathJax extension in Sphinx to get a LaTeX rendering for the docs (and IPython interactive help):\r\n![maxleveqn](https://cloud.githubusercontent.com/assets/6528957/24876622/5e39c420-1dfa-11e7-8390-faa9dbe0073f.png)\r\n\r\nA  drawback, is that the LaTeX code for the above is pretty illegible when perusing a plain text docstring, so I left a more legable plain text rendering as a comment ( https://github.com/grlee77/pywt/blob/2a7ef8857046355e6a7f969a16df8295ead596e7/pywt/_dwt.py#L44) .  Is this a reasonable compromise?\r\n\r\ncloses #306\r\n\r\n","created_at":"2017-04-10T18:39:31Z","updated_at":"2017-12-03T08:14:20Z","closed_at":"2017-12-03T08:14:20Z","merged_at":"2017-12-03T08:14:19Z","merge_commit_sha":"a7f034b8b0e3ffe06ed1665e3def258fc7d9e780","assignee":null,"assignees":[],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/PyWavelets/pywt/pulls/309/commits","review_comments_url":"https://api.github.com/repos/PyWavelets/pywt/pulls/309/comments","review_comment_url":"https://api.github.com/repos/PyWavelets/pywt/pulls/comments{/number}","comments_url":"https://api.github.com/repos/PyWavelets/pywt/issues/309/comments","statuses_url":"https://api.github.com/repos/PyWavelets/pywt/statuses/2a7ef8857046355e6a7f969a16df8295ead596e7","head":{"label":"grlee77:dwt_max_lev_docs","ref":"dwt_max_lev_docs","sha":"2a7ef8857046355e6a7f969a16df8295ead596e7","user":{"login":"grlee77","id":6528957,"avatar_url":"https://avatars3.githubusercontent.com/u/6528957?v=4","gravatar_id":"","url":"https://api.github.com/users/grlee77","html_url":"https://github.com/grlee77","followers_url":"https://api.github.com/users/grlee77/followers","following_url":"https://api.github.com/users/grlee77/following{/other_user}","gists_url":"https://api.github.com/users/grlee77/gists{/gist_id}","starred_url":"https://api.github.com/users/grlee77/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/grlee77/subscriptions","organizations_url":"https://api.github.com/users/grlee77/orgs","repos_url":"https://api.github.com/users/grlee77/repos","events_url":"https://api.github.com/users/grlee77/events{/privacy}","received_events_url":"https://api.github.com/users/grlee77/received_events","type":"User","site_admin":false},"repo":{"id":21228836,"name":"pywt","full_name":"grlee77/pywt","owner":{"login":"grlee77","id":6528957,"avatar_url":"https://avatars3.githubusercontent.com/u/6528957?v=4","gravatar_id":"","url":"https://api.github.com/users/grlee77","html_url":"https://github.com/grlee77","followers_url":"https://api.github.com/users/grlee77/followers","following_url":"https://api.github.com/users/grlee77/following{/other_user}","gists_url":"https://api.github.com/users/grlee77/gists{/gist_id}","starred_url":"https://api.github.com/users/grlee77/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/grlee77/subscriptions","organizations_url":"https://api.github.com/users/grlee77/orgs","repos_url":"https://api.github.com/users/grlee77/repos","events_url":"https://api.github.com/users/grlee77/events{/privacy}","received_events_url":"https://api.github.com/users/grlee77/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/grlee77/pywt","description":"PyWavelets - Discrete Wavelet Transform in Python","fork":true,"url":"https://api.github.com/repos/grlee77/pywt","forks_url":"https://api.github.com/repos/grlee77/pywt/forks","keys_url":"https://api.github.com/repos/grlee77/pywt/keys{/key_id}","collaborators_url":"https://api.github.com/repos/grlee77/pywt/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/grlee77/pywt/teams","hooks_url":"https://api.github.com/repos/grlee77/pywt/hooks","issue_events_url":"https://api.github.com/repos/grlee77/pywt/issues/events{/number}","events_url":"https://api.github.com/repos/grlee77/pywt/events","assignees_url":"https://api.github.com/repos/grlee77/pywt/assignees{/user}","branches_url":"https://api.github.com/repos/grlee77/pywt/branches{/branch}","tags_url":"https://api.github.com/repos/grlee77/pywt/tags","blobs_url":"https://api.github.com/repos/grlee77/pywt/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/grlee77/pywt/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/grlee77/pywt/git/refs{/sha}","trees_url":"https://api.github.com/repos/grlee77/pywt/git/trees{/sha}","statuses_url":"https://api.github.com/repos/grlee77/pywt/statuses/{sha}","languages_url":"https://api.github.com/repos/grlee77/pywt/languages","stargazers_url":"https://api.github.com/repos/grlee77/pywt/stargazers","contributors_url":"https://api.github.com/repos/grlee77/pywt/contributors","subscribers_url":"https://api.github.com/repos/grlee77/pywt/subscribers","subscription_url":"https://api.github.com/repos/grlee77/pywt/subscription","commits_url":"https://api.github.com/repos/grlee77/pywt/commits{/sha}","git_commits_url":"https://api.github.com/repos/grlee77/pywt/git/commits{/sha}","comments_url":"https://api.github.com/repos/grlee77/pywt/comments{/number}","issue_comment_url":"https://api.github.com/repos/grlee77/pywt/issues/comments{/number}","contents_url":"https://api.github.com/repos/grlee77/pywt/contents/{+path}","compare_url":"https://api.github.com/repos/grlee77/pywt/compare/{base}...{head}","merges_url":"https://api.github.com/repos/grlee77/pywt/merges","archive_url":"https://api.github.com/repos/grlee77/pywt/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/grlee77/pywt/downloads","issues_url":"https://api.github.com/repos/grlee77/pywt/issues{/number}","pulls_url":"https://api.github.com/repos/grlee77/pywt/pulls{/number}","milestones_url":"https://api.github.com/repos/grlee77/pywt/milestones{/number}","notifications_url":"https://api.github.com/repos/grlee77/pywt/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/grlee77/pywt/labels{/name}","releases_url":"https://api.github.com/repos/grlee77/pywt/releases{/id}","deployments_url":"https://api.github.com/repos/grlee77/pywt/deployments","created_at":"2014-06-26T05:15:21Z","updated_at":"2016-07-08T09:13:32Z","pushed_at":"2017-11-29T16:47:52Z","git_url":"git://github.com/grlee77/pywt.git","ssh_url":"git@github.com:grlee77/pywt.git","clone_url":"https://github.com/grlee77/pywt.git","svn_url":"https://github.com/grlee77/pywt","homepage":"http://www.pybytes.com/pywavelets/","size":11986,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":1,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"PyWavelets:master","ref":"master","sha":"dd7b79332f6afac345be8dae3e6dffe2edb5facc","user":{"login":"PyWavelets","id":13541085,"avatar_url":"https://avatars1.githubusercontent.com/u/13541085?v=4","gravatar_id":"","url":"https://api.github.com/users/PyWavelets","html_url":"https://github.com/PyWavelets","followers_url":"https://api.github.com/users/PyWavelets/followers","following_url":"https://api.github.com/users/PyWavelets/following{/other_user}","gists_url":"https://api.github.com/users/PyWavelets/gists{/gist_id}","starred_url":"https://api.github.com/users/PyWavelets/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PyWavelets/subscriptions","organizations_url":"https://api.github.com/users/PyWavelets/orgs","repos_url":"https://api.github.com/users/PyWavelets/repos","events_url":"https://api.github.com/users/PyWavelets/events{/privacy}","received_events_url":"https://api.github.com/users/PyWavelets/received_events","type":"Organization","site_admin":false},"repo":{"id":11591264,"name":"pywt","full_name":"PyWavelets/pywt","owner":{"login":"PyWavelets","id":13541085,"avatar_url":"https://avatars1.githubusercontent.com/u/13541085?v=4","gravatar_id":"","url":"https://api.github.com/users/PyWavelets","html_url":"https://github.com/PyWavelets","followers_url":"https://api.github.com/users/PyWavelets/followers","following_url":"https://api.github.com/users/PyWavelets/following{/other_user}","gists_url":"https://api.github.com/users/PyWavelets/gists{/gist_id}","starred_url":"https://api.github.com/users/PyWavelets/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/PyWavelets/subscriptions","organizations_url":"https://api.github.com/users/PyWavelets/orgs","repos_url":"https://api.github.com/users/PyWavelets/repos","events_url":"https://api.github.com/users/PyWavelets/events{/privacy}","received_events_url":"https://api.github.com/users/PyWavelets/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/PyWavelets/pywt","description":"PyWavelets - Wavelet Transforms in Python","fork":true,"url":"https://api.github.com/repos/PyWavelets/pywt","forks_url":"https://api.github.com/repos/PyWavelets/pywt/forks","keys_url":"https://api.github.com/repos/PyWavelets/pywt/keys{/key_id}","collaborators_url":"https://api.github.com/repos/PyWavelets/pywt/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/PyWavelets/pywt/teams","hooks_url":"https://api.github.com/repos/PyWavelets/pywt/hooks","issue_events_url":"https://api.github.com/repos/PyWavelets/pywt/issues/events{/number}","events_url":"https://api.github.com/repos/PyWavelets/pywt/events","assignees_url":"https://api.github.com/repos/PyWavelets/pywt/assignees{/user}","branches_url":"https://api.github.com/repos/PyWavelets/pywt/branches{/branch}","tags_url":"https://api.github.com/repos/PyWavelets/pywt/tags","blobs_url":"https://api.github.com/repos/PyWavelets/pywt/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/PyWavelets/pywt/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/PyWavelets/pywt/git/refs{/sha}","trees_url":"https://api.github.com/repos/PyWavelets/pywt/git/trees{/sha}","statuses_url":"https://api.github.com/repos/PyWavelets/pywt/statuses/{sha}","languages_url":"https://api.github.com/repos/PyWavelets/pywt/languages","stargazers_url":"https://api.github.com/repos/PyWavelets/pywt/stargazers","contributors_url":"https://api.github.com/repos/PyWavelets/pywt/contributors","subscribers_url":"https://api.github.com/repos/PyWavelets/pywt/subscribers","subscription_url":"https://api.github.com/repos/PyWavelets/pywt/subscription","commits_url":"https://api.github.com/repos/PyWavelets/pywt/commits{/sha}","git_commits_url":"https://api.github.com/repos/PyWavelets/pywt/git/commits{/sha}","comments_url":"https://api.github.com/repos/PyWavelets/pywt/comments{/number}","issue_comment_url":"https://api.github.com/repos/PyWavelets/pywt/issues/comments{/number}","contents_url":"https://api.github.com/repos/PyWavelets/pywt/contents/{+path}","compare_url":"https://api.github.com/repos/PyWavelets/pywt/compare/{base}...{head}","merges_url":"https://api.github.com/repos/PyWavelets/pywt/merges","archive_url":"https://api.github.com/repos/PyWavelets/pywt/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/PyWavelets/pywt/downloads","issues_url":"https://api.github.com/repos/PyWavelets/pywt/issues{/number}","pulls_url":"https://api.github.com/repos/PyWavelets/pywt/pulls{/number}","milestones_url":"https://api.github.com/repos/PyWavelets/pywt/milestones{/number}","notifications_url":"https://api.github.com/repos/PyWavelets/pywt/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/PyWavelets/pywt/labels{/name}","releases_url":"https://api.github.com/repos/PyWavelets/pywt/releases{/id}","deployments_url":"https://api.github.com/repos/PyWavelets/pywt/deployments","created_at":"2013-07-22T20:10:04Z","updated_at":"2017-12-02T10:01:20Z","pushed_at":"2017-12-03T08:14:19Z","git_url":"git://github.com/PyWavelets/pywt.git","ssh_url":"git@github.com:PyWavelets/pywt.git","clone_url":"https://github.com/PyWavelets/pywt.git","svn_url":"https://github.com/PyWavelets/pywt","homepage":"http://pywavelets.readthedocs.org","size":11953,"stargazers_count":280,"watchers_count":280,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":93,"mirror_url":null,"archived":false,"open_issues_count":34,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit"},"forks":93,"open_issues":34,"watchers":280,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/PyWavelets/pywt/pulls/309"},"html":{"href":"https://github.com/PyWavelets/pywt/pull/309"},"issue":{"href":"https://api.github.com/repos/PyWavelets/pywt/issues/309"},"comments":{"href":"https://api.github.com/repos/PyWavelets/pywt/issues/309/comments"},"review_comments":{"href":"https://api.github.com/repos/PyWavelets/pywt/pulls/309/comments"},"review_comment":{"href":"https://api.github.com/repos/PyWavelets/pywt/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/PyWavelets/pywt/pulls/309/commits"},"statuses":{"href":"https://api.github.com/repos/PyWavelets/pywt/statuses/2a7ef8857046355e6a7f969a16df8295ead596e7"}},"author_association":"NONE","merged":true,"mergeable":null,"rebaseable":null,"mergeable_state":"unknown","merged_by":{"login":"rgommers","id":98330,"avatar_url":"https://avatars3.githubusercontent.com/u/98330?v=4","gravatar_id":"","url":"https://api.github.com/users/rgommers","html_url":"https://github.com/rgommers","followers_url":"https://api.github.com/users/rgommers/followers","following_url":"https://api.github.com/users/rgommers/following{/other_user}","gists_url":"https://api.github.com/users/rgommers/gists{/gist_id}","starred_url":"https://api.github.com/users/rgommers/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rgommers/subscriptions","organizations_url":"https://api.github.com/users/rgommers/orgs","repos_url":"https://api.github.com/users/rgommers/repos","events_url":"https://api.github.com/users/rgommers/events{/privacy}","received_events_url":"https://api.github.com/users/rgommers/received_events","type":"User","site_admin":false},"comments":3,"review_comments":0,"maintainer_can_modify":false,"commits":2,"additions":22,"deletions":2,"changed_files":3}}
{"actor":{"display_login":"rgommers"}}