{"action":"created","comment":{"url":"https://api.github.com/repos/saltstack/salt/pulls/comments/92900619","pull_request_review_id":13426386,"id":92900619,"diff_hunk":"@@ -0,0 +1,75 @@\n+# -*- coding: utf-8 -*-\n+'''\n+    tests.unit.doc_test\n+    ~~~~~~~~~~~~~~~~~~~~\n+'''\n+\n+# Import Python libs\n+from __future__ import absolute_import\n+import os\n+\n+# Import Salt Testing libs\n+from salttesting import TestCase\n+from salttesting.helpers import ensure_in_syspath\n+\n+# Import Salt libs\n+import salt.modules.cmdmod\n+\n+ensure_in_syspath('../')\n+\n+\n+class DocTestCase(TestCase):\n+    '''\n+    Unit test case for testing doc files and strings.\n+    '''\n+\n+    def test_check_for_doc_inline_markup(self):","path":"tests/unit/doc_test.py","position":26,"original_position":26,"commit_id":"62978cb7a03600269afd296e3464e9a35a1fc34f","original_commit_id":"62978cb7a03600269afd296e3464e9a35a1fc34f","user":{"login":"whiteinge","id":91293,"avatar_url":"https://avatars.githubusercontent.com/u/91293?v=3","gravatar_id":"","url":"https://api.github.com/users/whiteinge","html_url":"https://github.com/whiteinge","followers_url":"https://api.github.com/users/whiteinge/followers","following_url":"https://api.github.com/users/whiteinge/following{/other_user}","gists_url":"https://api.github.com/users/whiteinge/gists{/gist_id}","starred_url":"https://api.github.com/users/whiteinge/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/whiteinge/subscriptions","organizations_url":"https://api.github.com/users/whiteinge/orgs","repos_url":"https://api.github.com/users/whiteinge/repos","events_url":"https://api.github.com/users/whiteinge/events{/privacy}","received_events_url":"https://api.github.com/users/whiteinge/received_events","type":"User","site_admin":false},"body":"Awesome. 😀  🏆 ","created_at":"2016-12-16T22:59:48Z","updated_at":"2016-12-16T22:59:48Z","html_url":"https://github.com/saltstack/salt/pull/38320#discussion_r92900619","pull_request_url":"https://api.github.com/repos/saltstack/salt/pulls/38320","_links":{"self":{"href":"https://api.github.com/repos/saltstack/salt/pulls/comments/92900619"},"html":{"href":"https://github.com/saltstack/salt/pull/38320#discussion_r92900619"},"pull_request":{"href":"https://api.github.com/repos/saltstack/salt/pulls/38320"}}},"pull_request":{"url":"https://api.github.com/repos/saltstack/salt/pulls/38320","id":98403370,"html_url":"https://github.com/saltstack/salt/pull/38320","diff_url":"https://github.com/saltstack/salt/pull/38320.diff","patch_url":"https://github.com/saltstack/salt/pull/38320.patch","issue_url":"https://api.github.com/repos/saltstack/salt/issues/38320","number":38320,"state":"open","locked":false,"title":"Cleanup doc internal markup references","user":{"login":"rallytime","id":6547906,"avatar_url":"https://avatars.githubusercontent.com/u/6547906?v=3","gravatar_id":"","url":"https://api.github.com/users/rallytime","html_url":"https://github.com/rallytime","followers_url":"https://api.github.com/users/rallytime/followers","following_url":"https://api.github.com/users/rallytime/following{/other_user}","gists_url":"https://api.github.com/users/rallytime/gists{/gist_id}","starred_url":"https://api.github.com/users/rallytime/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rallytime/subscriptions","organizations_url":"https://api.github.com/users/rallytime/orgs","repos_url":"https://api.github.com/users/rallytime/repos","events_url":"https://api.github.com/users/rallytime/events{/privacy}","received_events_url":"https://api.github.com/users/rallytime/received_events","type":"User","site_admin":false},"body":"### What does this PR do?\r\nReplaces all of the relevant `:doc:` references with `:ref:` (and in some cases uses `:mod:` instead).\r\n\r\nI also wrote a unit test to comb through the docs to find new references of the `:doc:` option that are added in the future.\r\n\r\nI've been slowly knocking these out while I wait for various test runs, and I got them all in the 2016.3 branch. The later branches will be easier as this is merged forward.\r\n\r\n### What issues does this PR fix or reference?\r\nFixes #12788\r\n\r\n### Previous Behavior\r\n`:doc:` was present in many places through out the `doc/` and `salt/` codebase. `:ref:` is preferable as it allows links to survive moving/renaming docs.\r\n\r\n### New Behavior\r\n`:doc:` has been replaced with `:ref:` and `:mod:` markup tags instead.\r\n\r\n### Tests written?\r\n\r\nYes\r\n\r\nPlease review [Salt's Contributing Guide](https://docs.saltstack.com/en/latest/topics/development/contributing.html) for best practices.\r\n","created_at":"2016-12-16T21:09:26Z","updated_at":"2016-12-16T22:59:48Z","closed_at":null,"merged_at":null,"merge_commit_sha":"e9acdba10e0f07a35be03a98a7867b5d54147ce0","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/saltstack/salt/pulls/38320/commits","review_comments_url":"https://api.github.com/repos/saltstack/salt/pulls/38320/comments","review_comment_url":"https://api.github.com/repos/saltstack/salt/pulls/comments{/number}","comments_url":"https://api.github.com/repos/saltstack/salt/issues/38320/comments","statuses_url":"https://api.github.com/repos/saltstack/salt/statuses/62978cb7a03600269afd296e3464e9a35a1fc34f","head":{"label":"rallytime:cleanup-doc-refs","ref":"cleanup-doc-refs","sha":"62978cb7a03600269afd296e3464e9a35a1fc34f","user":{"login":"rallytime","id":6547906,"avatar_url":"https://avatars.githubusercontent.com/u/6547906?v=3","gravatar_id":"","url":"https://api.github.com/users/rallytime","html_url":"https://github.com/rallytime","followers_url":"https://api.github.com/users/rallytime/followers","following_url":"https://api.github.com/users/rallytime/following{/other_user}","gists_url":"https://api.github.com/users/rallytime/gists{/gist_id}","starred_url":"https://api.github.com/users/rallytime/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rallytime/subscriptions","organizations_url":"https://api.github.com/users/rallytime/orgs","repos_url":"https://api.github.com/users/rallytime/repos","events_url":"https://api.github.com/users/rallytime/events{/privacy}","received_events_url":"https://api.github.com/users/rallytime/received_events","type":"User","site_admin":false},"repo":{"id":16396182,"name":"salt","full_name":"rallytime/salt","owner":{"login":"rallytime","id":6547906,"avatar_url":"https://avatars.githubusercontent.com/u/6547906?v=3","gravatar_id":"","url":"https://api.github.com/users/rallytime","html_url":"https://github.com/rallytime","followers_url":"https://api.github.com/users/rallytime/followers","following_url":"https://api.github.com/users/rallytime/following{/other_user}","gists_url":"https://api.github.com/users/rallytime/gists{/gist_id}","starred_url":"https://api.github.com/users/rallytime/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rallytime/subscriptions","organizations_url":"https://api.github.com/users/rallytime/orgs","repos_url":"https://api.github.com/users/rallytime/repos","events_url":"https://api.github.com/users/rallytime/events{/privacy}","received_events_url":"https://api.github.com/users/rallytime/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/rallytime/salt","description":"Central system and configuration manager ","fork":true,"url":"https://api.github.com/repos/rallytime/salt","forks_url":"https://api.github.com/repos/rallytime/salt/forks","keys_url":"https://api.github.com/repos/rallytime/salt/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rallytime/salt/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rallytime/salt/teams","hooks_url":"https://api.github.com/repos/rallytime/salt/hooks","issue_events_url":"https://api.github.com/repos/rallytime/salt/issues/events{/number}","events_url":"https://api.github.com/repos/rallytime/salt/events","assignees_url":"https://api.github.com/repos/rallytime/salt/assignees{/user}","branches_url":"https://api.github.com/repos/rallytime/salt/branches{/branch}","tags_url":"https://api.github.com/repos/rallytime/salt/tags","blobs_url":"https://api.github.com/repos/rallytime/salt/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rallytime/salt/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rallytime/salt/git/refs{/sha}","trees_url":"https://api.github.com/repos/rallytime/salt/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rallytime/salt/statuses/{sha}","languages_url":"https://api.github.com/repos/rallytime/salt/languages","stargazers_url":"https://api.github.com/repos/rallytime/salt/stargazers","contributors_url":"https://api.github.com/repos/rallytime/salt/contributors","subscribers_url":"https://api.github.com/repos/rallytime/salt/subscribers","subscription_url":"https://api.github.com/repos/rallytime/salt/subscription","commits_url":"https://api.github.com/repos/rallytime/salt/commits{/sha}","git_commits_url":"https://api.github.com/repos/rallytime/salt/git/commits{/sha}","comments_url":"https://api.github.com/repos/rallytime/salt/comments{/number}","issue_comment_url":"https://api.github.com/repos/rallytime/salt/issues/comments{/number}","contents_url":"https://api.github.com/repos/rallytime/salt/contents/{+path}","compare_url":"https://api.github.com/repos/rallytime/salt/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rallytime/salt/merges","archive_url":"https://api.github.com/repos/rallytime/salt/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rallytime/salt/downloads","issues_url":"https://api.github.com/repos/rallytime/salt/issues{/number}","pulls_url":"https://api.github.com/repos/rallytime/salt/pulls{/number}","milestones_url":"https://api.github.com/repos/rallytime/salt/milestones{/number}","notifications_url":"https://api.github.com/repos/rallytime/salt/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rallytime/salt/labels{/name}","releases_url":"https://api.github.com/repos/rallytime/salt/releases{/id}","deployments_url":"https://api.github.com/repos/rallytime/salt/deployments","created_at":"2014-01-31T00:54:22Z","updated_at":"2015-05-05T15:21:56Z","pushed_at":"2016-12-16T22:27:00Z","git_url":"git://github.com/rallytime/salt.git","ssh_url":"git@github.com:rallytime/salt.git","clone_url":"https://github.com/rallytime/salt.git","svn_url":"https://github.com/rallytime/salt","homepage":"saltstack.org","size":153889,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"develop"}},"base":{"label":"saltstack:2016.3","ref":"2016.3","sha":"6367ca7d2a8d61cc41f9a2f7b7c0785b3126707f","user":{"login":"saltstack","id":1147473,"avatar_url":"https://avatars.githubusercontent.com/u/1147473?v=3","gravatar_id":"","url":"https://api.github.com/users/saltstack","html_url":"https://github.com/saltstack","followers_url":"https://api.github.com/users/saltstack/followers","following_url":"https://api.github.com/users/saltstack/following{/other_user}","gists_url":"https://api.github.com/users/saltstack/gists{/gist_id}","starred_url":"https://api.github.com/users/saltstack/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/saltstack/subscriptions","organizations_url":"https://api.github.com/users/saltstack/orgs","repos_url":"https://api.github.com/users/saltstack/repos","events_url":"https://api.github.com/users/saltstack/events{/privacy}","received_events_url":"https://api.github.com/users/saltstack/received_events","type":"Organization","site_admin":false},"repo":{"id":1390248,"name":"salt","full_name":"saltstack/salt","owner":{"login":"saltstack","id":1147473,"avatar_url":"https://avatars.githubusercontent.com/u/1147473?v=3","gravatar_id":"","url":"https://api.github.com/users/saltstack","html_url":"https://github.com/saltstack","followers_url":"https://api.github.com/users/saltstack/followers","following_url":"https://api.github.com/users/saltstack/following{/other_user}","gists_url":"https://api.github.com/users/saltstack/gists{/gist_id}","starred_url":"https://api.github.com/users/saltstack/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/saltstack/subscriptions","organizations_url":"https://api.github.com/users/saltstack/orgs","repos_url":"https://api.github.com/users/saltstack/repos","events_url":"https://api.github.com/users/saltstack/events{/privacy}","received_events_url":"https://api.github.com/users/saltstack/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/saltstack/salt","description":"Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here: ","fork":false,"url":"https://api.github.com/repos/saltstack/salt","forks_url":"https://api.github.com/repos/saltstack/salt/forks","keys_url":"https://api.github.com/repos/saltstack/salt/keys{/key_id}","collaborators_url":"https://api.github.com/repos/saltstack/salt/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/saltstack/salt/teams","hooks_url":"https://api.github.com/repos/saltstack/salt/hooks","issue_events_url":"https://api.github.com/repos/saltstack/salt/issues/events{/number}","events_url":"https://api.github.com/repos/saltstack/salt/events","assignees_url":"https://api.github.com/repos/saltstack/salt/assignees{/user}","branches_url":"https://api.github.com/repos/saltstack/salt/branches{/branch}","tags_url":"https://api.github.com/repos/saltstack/salt/tags","blobs_url":"https://api.github.com/repos/saltstack/salt/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/saltstack/salt/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/saltstack/salt/git/refs{/sha}","trees_url":"https://api.github.com/repos/saltstack/salt/git/trees{/sha}","statuses_url":"https://api.github.com/repos/saltstack/salt/statuses/{sha}","languages_url":"https://api.github.com/repos/saltstack/salt/languages","stargazers_url":"https://api.github.com/repos/saltstack/salt/stargazers","contributors_url":"https://api.github.com/repos/saltstack/salt/contributors","subscribers_url":"https://api.github.com/repos/saltstack/salt/subscribers","subscription_url":"https://api.github.com/repos/saltstack/salt/subscription","commits_url":"https://api.github.com/repos/saltstack/salt/commits{/sha}","git_commits_url":"https://api.github.com/repos/saltstack/salt/git/commits{/sha}","comments_url":"https://api.github.com/repos/saltstack/salt/comments{/number}","issue_comment_url":"https://api.github.com/repos/saltstack/salt/issues/comments{/number}","contents_url":"https://api.github.com/repos/saltstack/salt/contents/{+path}","compare_url":"https://api.github.com/repos/saltstack/salt/compare/{base}...{head}","merges_url":"https://api.github.com/repos/saltstack/salt/merges","archive_url":"https://api.github.com/repos/saltstack/salt/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/saltstack/salt/downloads","issues_url":"https://api.github.com/repos/saltstack/salt/issues{/number}","pulls_url":"https://api.github.com/repos/saltstack/salt/pulls{/number}","milestones_url":"https://api.github.com/repos/saltstack/salt/milestones{/number}","notifications_url":"https://api.github.com/repos/saltstack/salt/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/saltstack/salt/labels{/name}","releases_url":"https://api.github.com/repos/saltstack/salt/releases{/id}","deployments_url":"https://api.github.com/repos/saltstack/salt/deployments","created_at":"2011-02-20T20:16:56Z","updated_at":"2016-12-16T20:53:19Z","pushed_at":"2016-12-16T22:39:54Z","git_url":"git://github.com/saltstack/salt.git","ssh_url":"git@github.com:saltstack/salt.git","clone_url":"https://github.com/saltstack/salt.git","svn_url":"https://github.com/saltstack/salt","homepage":"https://repo.saltstack.com/","size":156034,"stargazers_count":7169,"watchers_count":7169,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3293,"mirror_url":null,"open_issues_count":4105,"forks":3293,"open_issues":4105,"watchers":7169,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/saltstack/salt/pulls/38320"},"html":{"href":"https://github.com/saltstack/salt/pull/38320"},"issue":{"href":"https://api.github.com/repos/saltstack/salt/issues/38320"},"comments":{"href":"https://api.github.com/repos/saltstack/salt/issues/38320/comments"},"review_comments":{"href":"https://api.github.com/repos/saltstack/salt/pulls/38320/comments"},"review_comment":{"href":"https://api.github.com/repos/saltstack/salt/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/saltstack/salt/pulls/38320/commits"},"statuses":{"href":"https://api.github.com/repos/saltstack/salt/statuses/62978cb7a03600269afd296e3464e9a35a1fc34f"}}}}
{"actor":{"display_login":"whiteinge"}}