{"action":"created","comment":{"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments/76241710","id":76241710,"diff_hunk":"@@ -49,3 +49,16 @@ Our components written in Python don't share a common makefile infrastructure. H\n * `make test` to run all of the test cases.\n * `make coverage` to view the current unit test coverage.\n * `make verify` to run [flake8](http://flake8.pycqa.org/en/latest/) over the code to detect errors.\n+\n+\n+We do not use tools like pylint by default, as they can be too aggressive and provide a large number of benign errors, often in third party modules. However, it can be difficult to track down import errors using the standard test infrastructure we have in place, and it can be useful under these circumstances to be able to run pylint to draw out any bad imports that might be causing the modules or unit tests to fail.\n+\n+The following commands should install and run pylint in your local virtual environment:\n+\n+```\n+make clean && make env\n+_env/bin/easy_install pylint\n+PYTHONPATH=src:common _env/bin/python -m --disable=all --enable=F,E --output-format json <path_to_modules>\n+```\n+\n+Where the path_to_modules is the module or package directory of the code you want to check. For our projects, this will usually be under `src/metaswitch/`.","path":"docs/Running_unit_tests.md","position":16,"original_position":16,"commit_id":"078249e2c09737f6202b23ebdabffab7d52e75ec","original_commit_id":"078249e2c09737f6202b23ebdabffab7d52e75ec","user":{"login":"eleanor-merry","id":5425325,"avatar_url":"https://avatars.githubusercontent.com/u/5425325?v=3","gravatar_id":"","url":"https://api.github.com/users/eleanor-merry","html_url":"https://github.com/eleanor-merry","followers_url":"https://api.github.com/users/eleanor-merry/followers","following_url":"https://api.github.com/users/eleanor-merry/following{/other_user}","gists_url":"https://api.github.com/users/eleanor-merry/gists{/gist_id}","starred_url":"https://api.github.com/users/eleanor-merry/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eleanor-merry/subscriptions","organizations_url":"https://api.github.com/users/eleanor-merry/orgs","repos_url":"https://api.github.com/users/eleanor-merry/repos","events_url":"https://api.github.com/users/eleanor-merry/events{/privacy}","received_events_url":"https://api.github.com/users/eleanor-merry/received_events","type":"User","site_admin":false},"body":"put path_to_modules in `?","created_at":"2016-08-25T13:26:48Z","updated_at":"2016-08-25T13:26:48Z","html_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/211#discussion_r76241710","pull_request_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211","_links":{"self":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments/76241710"},"html":{"href":"https://github.com/Metaswitch/clearwater-readthedocs/pull/211#discussion_r76241710"},"pull_request":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211"}}},"pull_request":{"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211","id":82717199,"html_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/211","diff_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/211.diff","patch_url":"https://github.com/Metaswitch/clearwater-readthedocs/pull/211.patch","issue_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/211","number":211,"state":"open","locked":false,"title":"[Reviewer: Ellie] Document how to install and run pylint to detect import errors","user":{"login":"johadalin","id":14074163,"avatar_url":"https://avatars.githubusercontent.com/u/14074163?v=3","gravatar_id":"","url":"https://api.github.com/users/johadalin","html_url":"https://github.com/johadalin","followers_url":"https://api.github.com/users/johadalin/followers","following_url":"https://api.github.com/users/johadalin/following{/other_user}","gists_url":"https://api.github.com/users/johadalin/gists{/gist_id}","starred_url":"https://api.github.com/users/johadalin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/johadalin/subscriptions","organizations_url":"https://api.github.com/users/johadalin/orgs","repos_url":"https://api.github.com/users/johadalin/repos","events_url":"https://api.github.com/users/johadalin/events{/privacy}","received_events_url":"https://api.github.com/users/johadalin/received_events","type":"User","site_admin":false},"body":"Works on my system. Could you just quickly double check it works on yours in case my paths are different or whatever? ","created_at":"2016-08-25T13:14:11Z","updated_at":"2016-08-25T13:26:48Z","closed_at":null,"merged_at":null,"merge_commit_sha":"ca437e78d4055ffb58f39727f264f89694b78982","assignee":{"login":"eleanor-merry","id":5425325,"avatar_url":"https://avatars.githubusercontent.com/u/5425325?v=3","gravatar_id":"","url":"https://api.github.com/users/eleanor-merry","html_url":"https://github.com/eleanor-merry","followers_url":"https://api.github.com/users/eleanor-merry/followers","following_url":"https://api.github.com/users/eleanor-merry/following{/other_user}","gists_url":"https://api.github.com/users/eleanor-merry/gists{/gist_id}","starred_url":"https://api.github.com/users/eleanor-merry/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eleanor-merry/subscriptions","organizations_url":"https://api.github.com/users/eleanor-merry/orgs","repos_url":"https://api.github.com/users/eleanor-merry/repos","events_url":"https://api.github.com/users/eleanor-merry/events{/privacy}","received_events_url":"https://api.github.com/users/eleanor-merry/received_events","type":"User","site_admin":false},"assignees":[{"login":"eleanor-merry","id":5425325,"avatar_url":"https://avatars.githubusercontent.com/u/5425325?v=3","gravatar_id":"","url":"https://api.github.com/users/eleanor-merry","html_url":"https://github.com/eleanor-merry","followers_url":"https://api.github.com/users/eleanor-merry/followers","following_url":"https://api.github.com/users/eleanor-merry/following{/other_user}","gists_url":"https://api.github.com/users/eleanor-merry/gists{/gist_id}","starred_url":"https://api.github.com/users/eleanor-merry/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eleanor-merry/subscriptions","organizations_url":"https://api.github.com/users/eleanor-merry/orgs","repos_url":"https://api.github.com/users/eleanor-merry/repos","events_url":"https://api.github.com/users/eleanor-merry/events{/privacy}","received_events_url":"https://api.github.com/users/eleanor-merry/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211/commits","review_comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211/comments","review_comment_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/211/comments","statuses_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/078249e2c09737f6202b23ebdabffab7d52e75ec","head":{"label":"Metaswitch:pylint_testing","ref":"pylint_testing","sha":"078249e2c09737f6202b23ebdabffab7d52e75ec","user":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"repo":{"id":30247023,"name":"clearwater-readthedocs","full_name":"Metaswitch/clearwater-readthedocs","owner":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Metaswitch/clearwater-readthedocs","description":"Source repository for Clearwater's ReadTheDocs.org documentation","fork":false,"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs","forks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/forks","keys_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/teams","hooks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/hooks","issue_events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/events{/number}","events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/events","assignees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/assignees{/user}","branches_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/branches{/branch}","tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/tags","blobs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/refs{/sha}","trees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/{sha}","languages_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/languages","stargazers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/stargazers","contributors_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contributors","subscribers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscribers","subscription_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscription","commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/commits{/sha}","git_commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/commits{/sha}","comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/comments{/number}","issue_comment_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/comments{/number}","contents_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contents/{+path}","compare_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/merges","archive_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/downloads","issues_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues{/number}","pulls_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls{/number}","milestones_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/milestones{/number}","notifications_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/labels{/name}","releases_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/releases{/id}","deployments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/deployments","created_at":"2015-02-03T14:37:16Z","updated_at":"2016-03-03T20:16:57Z","pushed_at":"2016-08-25T13:14:11Z","git_url":"git://github.com/Metaswitch/clearwater-readthedocs.git","ssh_url":"git@github.com:Metaswitch/clearwater-readthedocs.git","clone_url":"https://github.com/Metaswitch/clearwater-readthedocs.git","svn_url":"https://github.com/Metaswitch/clearwater-readthedocs","homepage":null,"size":1424,"stargazers_count":0,"watchers_count":0,"language":"Makefile","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":4,"mirror_url":null,"open_issues_count":13,"forks":4,"open_issues":13,"watchers":0,"default_branch":"master"}},"base":{"label":"Metaswitch:master","ref":"master","sha":"d53b4238bad3f71e7c000eafc8e4778b02d8642d","user":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"repo":{"id":30247023,"name":"clearwater-readthedocs","full_name":"Metaswitch/clearwater-readthedocs","owner":{"login":"Metaswitch","id":453759,"avatar_url":"https://avatars.githubusercontent.com/u/453759?v=3","gravatar_id":"","url":"https://api.github.com/users/Metaswitch","html_url":"https://github.com/Metaswitch","followers_url":"https://api.github.com/users/Metaswitch/followers","following_url":"https://api.github.com/users/Metaswitch/following{/other_user}","gists_url":"https://api.github.com/users/Metaswitch/gists{/gist_id}","starred_url":"https://api.github.com/users/Metaswitch/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Metaswitch/subscriptions","organizations_url":"https://api.github.com/users/Metaswitch/orgs","repos_url":"https://api.github.com/users/Metaswitch/repos","events_url":"https://api.github.com/users/Metaswitch/events{/privacy}","received_events_url":"https://api.github.com/users/Metaswitch/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Metaswitch/clearwater-readthedocs","description":"Source repository for Clearwater's ReadTheDocs.org documentation","fork":false,"url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs","forks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/forks","keys_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/teams","hooks_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/hooks","issue_events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/events{/number}","events_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/events","assignees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/assignees{/user}","branches_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/branches{/branch}","tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/tags","blobs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/refs{/sha}","trees_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/{sha}","languages_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/languages","stargazers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/stargazers","contributors_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contributors","subscribers_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscribers","subscription_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/subscription","commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/commits{/sha}","git_commits_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/git/commits{/sha}","comments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/comments{/number}","issue_comment_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/comments{/number}","contents_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/contents/{+path}","compare_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/merges","archive_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/downloads","issues_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues{/number}","pulls_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls{/number}","milestones_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/milestones{/number}","notifications_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/labels{/name}","releases_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/releases{/id}","deployments_url":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/deployments","created_at":"2015-02-03T14:37:16Z","updated_at":"2016-03-03T20:16:57Z","pushed_at":"2016-08-25T13:14:11Z","git_url":"git://github.com/Metaswitch/clearwater-readthedocs.git","ssh_url":"git@github.com:Metaswitch/clearwater-readthedocs.git","clone_url":"https://github.com/Metaswitch/clearwater-readthedocs.git","svn_url":"https://github.com/Metaswitch/clearwater-readthedocs","homepage":null,"size":1424,"stargazers_count":0,"watchers_count":0,"language":"Makefile","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":4,"mirror_url":null,"open_issues_count":13,"forks":4,"open_issues":13,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211"},"html":{"href":"https://github.com/Metaswitch/clearwater-readthedocs/pull/211"},"issue":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/211"},"comments":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/issues/211/comments"},"review_comments":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211/comments"},"review_comment":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/pulls/211/commits"},"statuses":{"href":"https://api.github.com/repos/Metaswitch/clearwater-readthedocs/statuses/078249e2c09737f6202b23ebdabffab7d52e75ec"}}}}
{"actor":{"display_login":"eleanor-merry"}}