GitHub PullRequestReviewCommentEvent at 2014-11-01 14:43:31
Repository: sublime-undocs
Actor: FichteFoll
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/comments/19704491","id":19704491,"diff_hunk":"@@ -0,0 +1,175 @@\n+========\n+Comments\n+========\n+\n+\n+Overview\n+========\n+\n+Sublime Text has default commands\n+to comment/uncomment lines of code.\n+Using comment metadata files,\n+it's possible to make these commands\n+work for any type of source code.\n+\n+\n+File Format\n+===========\n+\n+Comment metadata is stored in :file:`.tmPreferences` files\n+and uses the Property List format.\n+The file name can be arbitrary.\n+\n+**Note:** Comment metadata is declared simply as ``shellVariables``.\n+However, because comment metadata is commonly required by packages,\n+it's included in a separate topic\n+where it's easier to find.\n+\n+Example:\n+\n+.. code-block:: xml\n+\n+   <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n+   <!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n+   <plist version=\"1.0\">\n+   <dict>\n+      <key>name</key>\n+      <string>Comments</string>\n+      <key>scope</key>\n+      <string>source.dart</string>\n+      <key>settings</key>\n+      <dict>\n+         <key>shellVariables</key>\n+         <array>\n+            <dict>\n+               <key>name</key>\n+               <string>TM_COMMENT_START</string>\n+               <key>value</key>\n+               <string>/// </string>\n+            </dict>\n+            <dict>\n+               <key>name</key>\n+               <string>TM_COMMENT_DISABLE_INDENT</string>\n+               <key>value</key>\n+               <string>no</string>\n+            </dict>\n+         </array>\n+      </dict>\n+   </dict>\n+   </plist>\n+\n+\n+Structure of a Comment Metadata File\n+====================================\n+\n+All comment metadata files\n+share the same top-level structure:\n+\n+.. code-block:: xml\n+\n+   <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n+   <!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n+   <plist version=\"1.0\">\n+   <dict>\n+      ...\n+   </dict>\n+   </plist>\n+\n+These are all valid elements\n+in a comment metadata file.\n+\n+\n+``name``\n+   Name of the metadata file.\n+\n+::\n+\n+   <key>name</key>\n+   <string>Dart Comments</string>\n+\n+``scope``\n+   Required. Scope selector to determine\n+   in which context the metadata should be active.\n+\n+::\n+\n+   <key>scope</key>\n+   <string>source.dart</string>\n+\n+``settings``\n+   Required. Contains other elements.\n+\n+::\n+\n+   <key>settings</key>\n+   <dict>\n+   ...\n+   </dict>\n+\n+``shellVariables``\n+   Required. Child of ``settings``.\n+   Required. Contains other elements.\n+\n+::\n+\n+   <key>shellVariables</key>\n+   <array>\n+   ...\n+   </array>\n+\n+``TM_COMMENT_START``\n+   Child of ``shellVariables``.\n+   Defines a default comment marker.\n+   To add more types of comment markers,\n+   (for example, block comments)\n+   use a name like ``TM_COMMENT_START_2``.\n+\n+::\n+\n+   <dict>\n+      <key>name</key>\n+      <string>TM_COMMENT_START</string>\n+      <key>value</key>\n+      <string>/// </string>\n+   </dict>\n+\n+``TM_COMMENT_END``\n+   Optional. Child of ``shellVariables``.\n+   Defines an end marker for a comment block.\n+   To add more types of comment end markers,\n+   use a name like ``TM_COMMENT_END_2``.\n+\n+::\n+\n+   <dict>\n+      <key>name</key>\n+      <string>TM_COMMENT_END</string>\n+      <key>value</key>\n+      <string>*/</string>\n+   </dict>\n+\n+.. TODO: no idea whether the below info is correct.\n+\n+``TM_COMMENT_DISABLE_INDENT``\n+   Optional. Child of ``shellVariables``.\n+   Controls whether automatic indenting\n+   should be applied to comments.\n+   Valid values: ``yes``, ``no``.\n+\n+::\n+\n+   <key>name</key>\n+   <string>TM_COMMENT_DISABLE_INDENT</string>\n+   <key>value</key>\n+   <string>no</string>\n+\n+","path":"source/reference/comments.rst","position":166,"original_position":166,"commit_id":"fdc0e0b13c4601beadc691c1284711175be2ba81","original_commit_id":"fdc0e0b13c4601beadc691c1284711175be2ba81","user":{"login":"FichteFoll","id":931051,"avatar_url":"https://avatars.githubusercontent.com/u/931051?v=2","gravatar_id":"","url":"https://api.github.com/users/FichteFoll","html_url":"https://github.com/FichteFoll","followers_url":"https://api.github.com/users/FichteFoll/followers","following_url":"https://api.github.com/users/FichteFoll/following{/other_user}","gists_url":"https://api.github.com/users/FichteFoll/gists{/gist_id}","starred_url":"https://api.github.com/users/FichteFoll/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/FichteFoll/subscriptions","organizations_url":"https://api.github.com/users/FichteFoll/orgs","repos_url":"https://api.github.com/users/FichteFoll/repos","events_url":"https://api.github.com/users/FichteFoll/events{/privacy}","received_events_url":"https://api.github.com/users/FichteFoll/received_events","type":"User","site_admin":false},"body":"There should be a complete example with a line and a block comment syntax at the end (so here). JavaScript is a nice candidate.","created_at":"2014-11-01T14:43:31Z","updated_at":"2014-11-01T14:43:31Z","html_url":"https://github.com/guillermooo/sublime-undocs/pull/102#discussion_r19704491","pull_request_url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102","_links":{"self":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/comments/19704491"},"html":{"href":"https://github.com/guillermooo/sublime-undocs/pull/102#discussion_r19704491"},"pull_request":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102"}}},"pull_request":{"url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102","id":23640730,"html_url":"https://github.com/guillermooo/sublime-undocs/pull/102","diff_url":"https://github.com/guillermooo/sublime-undocs/pull/102.diff","patch_url":"https://github.com/guillermooo/sublime-undocs/pull/102.patch","issue_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/102","number":102,"state":"open","locked":false,"title":"wip: comments, symbols, metadata","user":{"login":"guillermooo","id":684948,"avatar_url":"https://avatars.githubusercontent.com/u/684948?v=2","gravatar_id":"","url":"https://api.github.com/users/guillermooo","html_url":"https://github.com/guillermooo","followers_url":"https://api.github.com/users/guillermooo/followers","following_url":"https://api.github.com/users/guillermooo/following{/other_user}","gists_url":"https://api.github.com/users/guillermooo/gists{/gist_id}","starred_url":"https://api.github.com/users/guillermooo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/guillermooo/subscriptions","organizations_url":"https://api.github.com/users/guillermooo/orgs","repos_url":"https://api.github.com/users/guillermooo/repos","events_url":"https://api.github.com/users/guillermooo/events{/privacy}","received_events_url":"https://api.github.com/users/guillermooo/received_events","type":"User","site_admin":false},"body":"","created_at":"2014-10-30T21:35:29Z","updated_at":"2014-11-01T14:43:31Z","closed_at":null,"merged_at":null,"merge_commit_sha":"d70a26f1391eb975b5a8954437887bee9d9ec1d8","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102/commits","review_comments_url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102/comments","review_comment_url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/comments/{number}","comments_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/102/comments","statuses_url":"https://api.github.com/repos/guillermooo/sublime-undocs/statuses/fdc0e0b13c4601beadc691c1284711175be2ba81","head":{"label":"guillermooo:new-topic-metadata","ref":"new-topic-metadata","sha":"fdc0e0b13c4601beadc691c1284711175be2ba81","user":{"login":"guillermooo","id":684948,"avatar_url":"https://avatars.githubusercontent.com/u/684948?v=2","gravatar_id":"","url":"https://api.github.com/users/guillermooo","html_url":"https://github.com/guillermooo","followers_url":"https://api.github.com/users/guillermooo/followers","following_url":"https://api.github.com/users/guillermooo/following{/other_user}","gists_url":"https://api.github.com/users/guillermooo/gists{/gist_id}","starred_url":"https://api.github.com/users/guillermooo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/guillermooo/subscriptions","organizations_url":"https://api.github.com/users/guillermooo/orgs","repos_url":"https://api.github.com/users/guillermooo/repos","events_url":"https://api.github.com/users/guillermooo/events{/privacy}","received_events_url":"https://api.github.com/users/guillermooo/received_events","type":"User","site_admin":false},"repo":{"id":12328926,"name":"sublime-undocs","full_name":"guillermooo/sublime-undocs","owner":{"login":"guillermooo","id":684948,"avatar_url":"https://avatars.githubusercontent.com/u/684948?v=2","gravatar_id":"","url":"https://api.github.com/users/guillermooo","html_url":"https://github.com/guillermooo","followers_url":"https://api.github.com/users/guillermooo/followers","following_url":"https://api.github.com/users/guillermooo/following{/other_user}","gists_url":"https://api.github.com/users/guillermooo/gists{/gist_id}","starred_url":"https://api.github.com/users/guillermooo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/guillermooo/subscriptions","organizations_url":"https://api.github.com/users/guillermooo/orgs","repos_url":"https://api.github.com/users/guillermooo/repos","events_url":"https://api.github.com/users/guillermooo/events{/privacy}","received_events_url":"https://api.github.com/users/guillermooo/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/guillermooo/sublime-undocs","description":"Sublime Text Unofficial Documentation","fork":false,"url":"https://api.github.com/repos/guillermooo/sublime-undocs","forks_url":"https://api.github.com/repos/guillermooo/sublime-undocs/forks","keys_url":"https://api.github.com/repos/guillermooo/sublime-undocs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/guillermooo/sublime-undocs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/guillermooo/sublime-undocs/teams","hooks_url":"https://api.github.com/repos/guillermooo/sublime-undocs/hooks","issue_events_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/events{/number}","events_url":"https://api.github.com/repos/guillermooo/sublime-undocs/events","assignees_url":"https://api.github.com/repos/guillermooo/sublime-undocs/assignees{/user}","branches_url":"https://api.github.com/repos/guillermooo/sublime-undocs/branches{/branch}","tags_url":"https://api.github.com/repos/guillermooo/sublime-undocs/tags","blobs_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/refs{/sha}","trees_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/guillermooo/sublime-undocs/statuses/{sha}","languages_url":"https://api.github.com/repos/guillermooo/sublime-undocs/languages","stargazers_url":"https://api.github.com/repos/guillermooo/sublime-undocs/stargazers","contributors_url":"https://api.github.com/repos/guillermooo/sublime-undocs/contributors","subscribers_url":"https://api.github.com/repos/guillermooo/sublime-undocs/subscribers","subscription_url":"https://api.github.com/repos/guillermooo/sublime-undocs/subscription","commits_url":"https://api.github.com/repos/guillermooo/sublime-undocs/commits{/sha}","git_commits_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/commits{/sha}","comments_url":"https://api.github.com/repos/guillermooo/sublime-undocs/comments{/number}","issue_comment_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/comments/{number}","contents_url":"https://api.github.com/repos/guillermooo/sublime-undocs/contents/{+path}","compare_url":"https://api.github.com/repos/guillermooo/sublime-undocs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/guillermooo/sublime-undocs/merges","archive_url":"https://api.github.com/repos/guillermooo/sublime-undocs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/guillermooo/sublime-undocs/downloads","issues_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues{/number}","pulls_url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls{/number}","milestones_url":"https://api.github.com/repos/guillermooo/sublime-undocs/milestones{/number}","notifications_url":"https://api.github.com/repos/guillermooo/sublime-undocs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/guillermooo/sublime-undocs/labels{/name}","releases_url":"https://api.github.com/repos/guillermooo/sublime-undocs/releases{/id}","created_at":"2013-08-23T17:43:58Z","updated_at":"2014-10-30T20:19:32Z","pushed_at":"2014-10-30T22:49:04Z","git_url":"git://github.com/guillermooo/sublime-undocs.git","ssh_url":"git@github.com:guillermooo/sublime-undocs.git","clone_url":"https://github.com/guillermooo/sublime-undocs.git","svn_url":"https://github.com/guillermooo/sublime-undocs","homepage":"http://docs.sublimetext.info","size":2507,"stargazers_count":149,"watchers_count":149,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":141,"mirror_url":null,"open_issues_count":19,"forks":141,"open_issues":19,"watchers":149,"default_branch":"sublime-text-3"}},"base":{"label":"guillermooo:sublime-text-3","ref":"sublime-text-3","sha":"5a0c76a35967356c1e99ae92604bfed7e9256238","user":{"login":"guillermooo","id":684948,"avatar_url":"https://avatars.githubusercontent.com/u/684948?v=2","gravatar_id":"","url":"https://api.github.com/users/guillermooo","html_url":"https://github.com/guillermooo","followers_url":"https://api.github.com/users/guillermooo/followers","following_url":"https://api.github.com/users/guillermooo/following{/other_user}","gists_url":"https://api.github.com/users/guillermooo/gists{/gist_id}","starred_url":"https://api.github.com/users/guillermooo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/guillermooo/subscriptions","organizations_url":"https://api.github.com/users/guillermooo/orgs","repos_url":"https://api.github.com/users/guillermooo/repos","events_url":"https://api.github.com/users/guillermooo/events{/privacy}","received_events_url":"https://api.github.com/users/guillermooo/received_events","type":"User","site_admin":false},"repo":{"id":12328926,"name":"sublime-undocs","full_name":"guillermooo/sublime-undocs","owner":{"login":"guillermooo","id":684948,"avatar_url":"https://avatars.githubusercontent.com/u/684948?v=2","gravatar_id":"","url":"https://api.github.com/users/guillermooo","html_url":"https://github.com/guillermooo","followers_url":"https://api.github.com/users/guillermooo/followers","following_url":"https://api.github.com/users/guillermooo/following{/other_user}","gists_url":"https://api.github.com/users/guillermooo/gists{/gist_id}","starred_url":"https://api.github.com/users/guillermooo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/guillermooo/subscriptions","organizations_url":"https://api.github.com/users/guillermooo/orgs","repos_url":"https://api.github.com/users/guillermooo/repos","events_url":"https://api.github.com/users/guillermooo/events{/privacy}","received_events_url":"https://api.github.com/users/guillermooo/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/guillermooo/sublime-undocs","description":"Sublime Text Unofficial Documentation","fork":false,"url":"https://api.github.com/repos/guillermooo/sublime-undocs","forks_url":"https://api.github.com/repos/guillermooo/sublime-undocs/forks","keys_url":"https://api.github.com/repos/guillermooo/sublime-undocs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/guillermooo/sublime-undocs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/guillermooo/sublime-undocs/teams","hooks_url":"https://api.github.com/repos/guillermooo/sublime-undocs/hooks","issue_events_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/events{/number}","events_url":"https://api.github.com/repos/guillermooo/sublime-undocs/events","assignees_url":"https://api.github.com/repos/guillermooo/sublime-undocs/assignees{/user}","branches_url":"https://api.github.com/repos/guillermooo/sublime-undocs/branches{/branch}","tags_url":"https://api.github.com/repos/guillermooo/sublime-undocs/tags","blobs_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/refs{/sha}","trees_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/guillermooo/sublime-undocs/statuses/{sha}","languages_url":"https://api.github.com/repos/guillermooo/sublime-undocs/languages","stargazers_url":"https://api.github.com/repos/guillermooo/sublime-undocs/stargazers","contributors_url":"https://api.github.com/repos/guillermooo/sublime-undocs/contributors","subscribers_url":"https://api.github.com/repos/guillermooo/sublime-undocs/subscribers","subscription_url":"https://api.github.com/repos/guillermooo/sublime-undocs/subscription","commits_url":"https://api.github.com/repos/guillermooo/sublime-undocs/commits{/sha}","git_commits_url":"https://api.github.com/repos/guillermooo/sublime-undocs/git/commits{/sha}","comments_url":"https://api.github.com/repos/guillermooo/sublime-undocs/comments{/number}","issue_comment_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/comments/{number}","contents_url":"https://api.github.com/repos/guillermooo/sublime-undocs/contents/{+path}","compare_url":"https://api.github.com/repos/guillermooo/sublime-undocs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/guillermooo/sublime-undocs/merges","archive_url":"https://api.github.com/repos/guillermooo/sublime-undocs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/guillermooo/sublime-undocs/downloads","issues_url":"https://api.github.com/repos/guillermooo/sublime-undocs/issues{/number}","pulls_url":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls{/number}","milestones_url":"https://api.github.com/repos/guillermooo/sublime-undocs/milestones{/number}","notifications_url":"https://api.github.com/repos/guillermooo/sublime-undocs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/guillermooo/sublime-undocs/labels{/name}","releases_url":"https://api.github.com/repos/guillermooo/sublime-undocs/releases{/id}","created_at":"2013-08-23T17:43:58Z","updated_at":"2014-10-30T20:19:32Z","pushed_at":"2014-10-30T22:49:04Z","git_url":"git://github.com/guillermooo/sublime-undocs.git","ssh_url":"git@github.com:guillermooo/sublime-undocs.git","clone_url":"https://github.com/guillermooo/sublime-undocs.git","svn_url":"https://github.com/guillermooo/sublime-undocs","homepage":"http://docs.sublimetext.info","size":2507,"stargazers_count":149,"watchers_count":149,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":141,"mirror_url":null,"open_issues_count":19,"forks":141,"open_issues":19,"watchers":149,"default_branch":"sublime-text-3"}},"_links":{"self":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102"},"html":{"href":"https://github.com/guillermooo/sublime-undocs/pull/102"},"issue":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/102"},"comments":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/issues/102/comments"},"review_comments":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102/comments"},"review_comment":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/pulls/102/commits"},"statuses":{"href":"https://api.github.com/repos/guillermooo/sublime-undocs/statuses/fdc0e0b13c4601beadc691c1284711175be2ba81"}}}}