{"action":"created","comment":{"url":"https://api.github.com/repos/ioos/APIRUS/pulls/comments/55664711","id":55664711,"diff_hunk":"@@ -0,0 +1,91 @@\n+Style Guide for APIRUS related projects.\n+########################################\n+\n+This document is designed to serve as a style guide for the APIRUS related pojects. The goal is to have a consistent coding style among the inter-related projects.\n+\n+VERSION: 0.1\n+\n+Overall Style\n+=============\n+\n+Follow:\n+\n+ - PEP 0008 -- Style Guide for Python Code\n+\n+and\n+\n+ - PEP 0257 -- Docstring Conventions\n+\n+But there are more details that are unspecified in those documents, so those are clarified here.\n+\n+Quote style\n+-----------\n+\n+single vs double quotes? -- someone decide, I don't care :-)\n+\n+\n+Specifying parameters to functions in docstrings\n+------------------------------------------------\n+\n+I think we should use either the \"raw\" sphinx approach::\n+\n+  :param name: the value you want to pass in\n+  :type name: the type required for name\n+\n+Or adopt the numpy extensions -- they are nicer, but require an extra plug-in...\n+\n+https://pypi.python.org/pypi/numpydoc\n+\n+\n+Line Continuations\n+------------------\n+\n+long lines need to get split, but there are multiple ways to do it.\n+\n+Use un-closed brackets whenever possible to support continuation.\n+\n+If a function definition or function call has too many parmaeters to all fit on one line, then put each on on it's own line. i.e.\n+\n+::\n+\n+    def __init__(self,\n+                 node_lon=None,\n+                 node_lat=None,\n+                 center_lon=None,\n+                 center_lat=None,\n+                 edges=None,\n+                 node_padding=None,\n+                 edge1_padding=None,\n+                 edge2_padding=None,\n+                 grid_topology_var=None,\n+                 variables=None,\n+                 grid_variables=None,\n+                 dimensions=None,\n+                 node_dimensions=None,\n+                 node_coordinates=None,\n+                 edge1_coordinates=None,\n+                 edge2_coordinates=None,\n+                 angles=None,\n+                 )","path":"style_guide.rst","position":69,"original_position":69,"commit_id":"896138039ebfc6824616492d4e59afc1c9521e50","original_commit_id":"896138039ebfc6824616492d4e59afc1c9521e50","user":{"login":"ocefpaf","id":950575,"avatar_url":"https://avatars.githubusercontent.com/u/950575?v=3","gravatar_id":"","url":"https://api.github.com/users/ocefpaf","html_url":"https://github.com/ocefpaf","followers_url":"https://api.github.com/users/ocefpaf/followers","following_url":"https://api.github.com/users/ocefpaf/following{/other_user}","gists_url":"https://api.github.com/users/ocefpaf/gists{/gist_id}","starred_url":"https://api.github.com/users/ocefpaf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ocefpaf/subscriptions","organizations_url":"https://api.github.com/users/ocefpaf/orgs","repos_url":"https://api.github.com/users/ocefpaf/repos","events_url":"https://api.github.com/users/ocefpaf/events{/privacy}","received_events_url":"https://api.github.com/users/ocefpaf/received_events","type":"User","site_admin":false},"body":"@rhattersley has a point. (And that discussion should be in `pysgrid` as this was copied from there.)","created_at":"2016-03-10T11:10:59Z","updated_at":"2016-03-10T11:10:59Z","html_url":"https://github.com/ioos/APIRUS/pull/18#discussion_r55664711","pull_request_url":"https://api.github.com/repos/ioos/APIRUS/pulls/18","_links":{"self":{"href":"https://api.github.com/repos/ioos/APIRUS/pulls/comments/55664711"},"html":{"href":"https://github.com/ioos/APIRUS/pull/18#discussion_r55664711"},"pull_request":{"href":"https://api.github.com/repos/ioos/APIRUS/pulls/18"}}},"pull_request":{"url":"https://api.github.com/repos/ioos/APIRUS/pulls/18","id":62278563,"html_url":"https://github.com/ioos/APIRUS/pull/18","diff_url":"https://github.com/ioos/APIRUS/pull/18.diff","patch_url":"https://github.com/ioos/APIRUS/pull/18.patch","issue_url":"https://api.github.com/repos/ioos/APIRUS/issues/18","number":18,"state":"closed","locked":false,"title":"added the start of a style guide.","user":{"login":"ChrisBarker-NOAA","id":916576,"avatar_url":"https://avatars.githubusercontent.com/u/916576?v=3","gravatar_id":"","url":"https://api.github.com/users/ChrisBarker-NOAA","html_url":"https://github.com/ChrisBarker-NOAA","followers_url":"https://api.github.com/users/ChrisBarker-NOAA/followers","following_url":"https://api.github.com/users/ChrisBarker-NOAA/following{/other_user}","gists_url":"https://api.github.com/users/ChrisBarker-NOAA/gists{/gist_id}","starred_url":"https://api.github.com/users/ChrisBarker-NOAA/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ChrisBarker-NOAA/subscriptions","organizations_url":"https://api.github.com/users/ChrisBarker-NOAA/orgs","repos_url":"https://api.github.com/users/ChrisBarker-NOAA/repos","events_url":"https://api.github.com/users/ChrisBarker-NOAA/events{/privacy}","received_events_url":"https://api.github.com/users/ChrisBarker-NOAA/received_events","type":"User","site_admin":false},"body":"Here's a start -- please review and we can then merge and start pointing to it from pysgrid and pyugrid.","created_at":"2016-03-09T19:03:27Z","updated_at":"2016-03-10T11:10:59Z","closed_at":"2016-03-09T20:57:51Z","merged_at":"2016-03-09T20:57:51Z","merge_commit_sha":"10da4fa4d299acd71971329f1fd8deefa86980de","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/ioos/APIRUS/pulls/18/commits","review_comments_url":"https://api.github.com/repos/ioos/APIRUS/pulls/18/comments","review_comment_url":"https://api.github.com/repos/ioos/APIRUS/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ioos/APIRUS/issues/18/comments","statuses_url":"https://api.github.com/repos/ioos/APIRUS/statuses/896138039ebfc6824616492d4e59afc1c9521e50","head":{"label":"ioos:style_guide","ref":"style_guide","sha":"896138039ebfc6824616492d4e59afc1c9521e50","user":{"login":"ioos","id":5313832,"avatar_url":"https://avatars.githubusercontent.com/u/5313832?v=3","gravatar_id":"","url":"https://api.github.com/users/ioos","html_url":"https://github.com/ioos","followers_url":"https://api.github.com/users/ioos/followers","following_url":"https://api.github.com/users/ioos/following{/other_user}","gists_url":"https://api.github.com/users/ioos/gists{/gist_id}","starred_url":"https://api.github.com/users/ioos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ioos/subscriptions","organizations_url":"https://api.github.com/users/ioos/orgs","repos_url":"https://api.github.com/users/ioos/repos","events_url":"https://api.github.com/users/ioos/events{/privacy}","received_events_url":"https://api.github.com/users/ioos/received_events","type":"Organization","site_admin":false},"repo":{"id":42546102,"name":"APIRUS","full_name":"ioos/APIRUS","owner":{"login":"ioos","id":5313832,"avatar_url":"https://avatars.githubusercontent.com/u/5313832?v=3","gravatar_id":"","url":"https://api.github.com/users/ioos","html_url":"https://github.com/ioos","followers_url":"https://api.github.com/users/ioos/followers","following_url":"https://api.github.com/users/ioos/following{/other_user}","gists_url":"https://api.github.com/users/ioos/gists{/gist_id}","starred_url":"https://api.github.com/users/ioos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ioos/subscriptions","organizations_url":"https://api.github.com/users/ioos/orgs","repos_url":"https://api.github.com/users/ioos/repos","events_url":"https://api.github.com/users/ioos/events{/privacy}","received_events_url":"https://api.github.com/users/ioos/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ioos/APIRUS","description":"API for Regular, Unstructured and Staggered model output  (or API R US)","fork":false,"url":"https://api.github.com/repos/ioos/APIRUS","forks_url":"https://api.github.com/repos/ioos/APIRUS/forks","keys_url":"https://api.github.com/repos/ioos/APIRUS/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ioos/APIRUS/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ioos/APIRUS/teams","hooks_url":"https://api.github.com/repos/ioos/APIRUS/hooks","issue_events_url":"https://api.github.com/repos/ioos/APIRUS/issues/events{/number}","events_url":"https://api.github.com/repos/ioos/APIRUS/events","assignees_url":"https://api.github.com/repos/ioos/APIRUS/assignees{/user}","branches_url":"https://api.github.com/repos/ioos/APIRUS/branches{/branch}","tags_url":"https://api.github.com/repos/ioos/APIRUS/tags","blobs_url":"https://api.github.com/repos/ioos/APIRUS/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ioos/APIRUS/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ioos/APIRUS/git/refs{/sha}","trees_url":"https://api.github.com/repos/ioos/APIRUS/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ioos/APIRUS/statuses/{sha}","languages_url":"https://api.github.com/repos/ioos/APIRUS/languages","stargazers_url":"https://api.github.com/repos/ioos/APIRUS/stargazers","contributors_url":"https://api.github.com/repos/ioos/APIRUS/contributors","subscribers_url":"https://api.github.com/repos/ioos/APIRUS/subscribers","subscription_url":"https://api.github.com/repos/ioos/APIRUS/subscription","commits_url":"https://api.github.com/repos/ioos/APIRUS/commits{/sha}","git_commits_url":"https://api.github.com/repos/ioos/APIRUS/git/commits{/sha}","comments_url":"https://api.github.com/repos/ioos/APIRUS/comments{/number}","issue_comment_url":"https://api.github.com/repos/ioos/APIRUS/issues/comments{/number}","contents_url":"https://api.github.com/repos/ioos/APIRUS/contents/{+path}","compare_url":"https://api.github.com/repos/ioos/APIRUS/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ioos/APIRUS/merges","archive_url":"https://api.github.com/repos/ioos/APIRUS/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ioos/APIRUS/downloads","issues_url":"https://api.github.com/repos/ioos/APIRUS/issues{/number}","pulls_url":"https://api.github.com/repos/ioos/APIRUS/pulls{/number}","milestones_url":"https://api.github.com/repos/ioos/APIRUS/milestones{/number}","notifications_url":"https://api.github.com/repos/ioos/APIRUS/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ioos/APIRUS/labels{/name}","releases_url":"https://api.github.com/repos/ioos/APIRUS/releases{/id}","deployments_url":"https://api.github.com/repos/ioos/APIRUS/deployments","created_at":"2015-09-15T20:56:48Z","updated_at":"2016-03-09T20:57:52Z","pushed_at":"2016-03-09T22:06:01Z","git_url":"git://github.com/ioos/APIRUS.git","ssh_url":"git@github.com:ioos/APIRUS.git","clone_url":"https://github.com/ioos/APIRUS.git","svn_url":"https://github.com/ioos/APIRUS","homepage":null,"size":13,"stargazers_count":2,"watchers_count":2,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":12,"forks":1,"open_issues":12,"watchers":2,"default_branch":"master"}},"base":{"label":"ioos:master","ref":"master","sha":"7b3e11633b09796a82481367d23fe96f6abe0eff","user":{"login":"ioos","id":5313832,"avatar_url":"https://avatars.githubusercontent.com/u/5313832?v=3","gravatar_id":"","url":"https://api.github.com/users/ioos","html_url":"https://github.com/ioos","followers_url":"https://api.github.com/users/ioos/followers","following_url":"https://api.github.com/users/ioos/following{/other_user}","gists_url":"https://api.github.com/users/ioos/gists{/gist_id}","starred_url":"https://api.github.com/users/ioos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ioos/subscriptions","organizations_url":"https://api.github.com/users/ioos/orgs","repos_url":"https://api.github.com/users/ioos/repos","events_url":"https://api.github.com/users/ioos/events{/privacy}","received_events_url":"https://api.github.com/users/ioos/received_events","type":"Organization","site_admin":false},"repo":{"id":42546102,"name":"APIRUS","full_name":"ioos/APIRUS","owner":{"login":"ioos","id":5313832,"avatar_url":"https://avatars.githubusercontent.com/u/5313832?v=3","gravatar_id":"","url":"https://api.github.com/users/ioos","html_url":"https://github.com/ioos","followers_url":"https://api.github.com/users/ioos/followers","following_url":"https://api.github.com/users/ioos/following{/other_user}","gists_url":"https://api.github.com/users/ioos/gists{/gist_id}","starred_url":"https://api.github.com/users/ioos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ioos/subscriptions","organizations_url":"https://api.github.com/users/ioos/orgs","repos_url":"https://api.github.com/users/ioos/repos","events_url":"https://api.github.com/users/ioos/events{/privacy}","received_events_url":"https://api.github.com/users/ioos/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ioos/APIRUS","description":"API for Regular, Unstructured and Staggered model output  (or API R US)","fork":false,"url":"https://api.github.com/repos/ioos/APIRUS","forks_url":"https://api.github.com/repos/ioos/APIRUS/forks","keys_url":"https://api.github.com/repos/ioos/APIRUS/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ioos/APIRUS/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ioos/APIRUS/teams","hooks_url":"https://api.github.com/repos/ioos/APIRUS/hooks","issue_events_url":"https://api.github.com/repos/ioos/APIRUS/issues/events{/number}","events_url":"https://api.github.com/repos/ioos/APIRUS/events","assignees_url":"https://api.github.com/repos/ioos/APIRUS/assignees{/user}","branches_url":"https://api.github.com/repos/ioos/APIRUS/branches{/branch}","tags_url":"https://api.github.com/repos/ioos/APIRUS/tags","blobs_url":"https://api.github.com/repos/ioos/APIRUS/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ioos/APIRUS/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ioos/APIRUS/git/refs{/sha}","trees_url":"https://api.github.com/repos/ioos/APIRUS/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ioos/APIRUS/statuses/{sha}","languages_url":"https://api.github.com/repos/ioos/APIRUS/languages","stargazers_url":"https://api.github.com/repos/ioos/APIRUS/stargazers","contributors_url":"https://api.github.com/repos/ioos/APIRUS/contributors","subscribers_url":"https://api.github.com/repos/ioos/APIRUS/subscribers","subscription_url":"https://api.github.com/repos/ioos/APIRUS/subscription","commits_url":"https://api.github.com/repos/ioos/APIRUS/commits{/sha}","git_commits_url":"https://api.github.com/repos/ioos/APIRUS/git/commits{/sha}","comments_url":"https://api.github.com/repos/ioos/APIRUS/comments{/number}","issue_comment_url":"https://api.github.com/repos/ioos/APIRUS/issues/comments{/number}","contents_url":"https://api.github.com/repos/ioos/APIRUS/contents/{+path}","compare_url":"https://api.github.com/repos/ioos/APIRUS/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ioos/APIRUS/merges","archive_url":"https://api.github.com/repos/ioos/APIRUS/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ioos/APIRUS/downloads","issues_url":"https://api.github.com/repos/ioos/APIRUS/issues{/number}","pulls_url":"https://api.github.com/repos/ioos/APIRUS/pulls{/number}","milestones_url":"https://api.github.com/repos/ioos/APIRUS/milestones{/number}","notifications_url":"https://api.github.com/repos/ioos/APIRUS/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ioos/APIRUS/labels{/name}","releases_url":"https://api.github.com/repos/ioos/APIRUS/releases{/id}","deployments_url":"https://api.github.com/repos/ioos/APIRUS/deployments","created_at":"2015-09-15T20:56:48Z","updated_at":"2016-03-09T20:57:52Z","pushed_at":"2016-03-09T22:06:01Z","git_url":"git://github.com/ioos/APIRUS.git","ssh_url":"git@github.com:ioos/APIRUS.git","clone_url":"https://github.com/ioos/APIRUS.git","svn_url":"https://github.com/ioos/APIRUS","homepage":null,"size":13,"stargazers_count":2,"watchers_count":2,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":12,"forks":1,"open_issues":12,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ioos/APIRUS/pulls/18"},"html":{"href":"https://github.com/ioos/APIRUS/pull/18"},"issue":{"href":"https://api.github.com/repos/ioos/APIRUS/issues/18"},"comments":{"href":"https://api.github.com/repos/ioos/APIRUS/issues/18/comments"},"review_comments":{"href":"https://api.github.com/repos/ioos/APIRUS/pulls/18/comments"},"review_comment":{"href":"https://api.github.com/repos/ioos/APIRUS/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ioos/APIRUS/pulls/18/commits"},"statuses":{"href":"https://api.github.com/repos/ioos/APIRUS/statuses/896138039ebfc6824616492d4e59afc1c9521e50"}}}}