GitHub PullRequestReviewCommentEvent at 2014-02-11 15:28:51
Repository: iris
Actor: dkillick
Payload: {"comment":{"url":"https://api.github.com/repos/SciTools/iris/pulls/comments/9627599","id":9627599,"diff_hunk":"@@ -470,6 +504,8 @@ def update_metadata(self, cube, coords, **kwargs):\n         \"\"\"\n         Update cube cell method metadata w.r.t the aggregation function.\n \n+        This function is only expected to be used by Iris.","path":"lib/iris/analysis/__init__.py","position":55,"original_position":55,"commit_id":"1ae488725f404aea284e7ac2ccdb5d4d0f1d2a4f","original_commit_id":"89d44130c6c851ce8bdeafc6cbb40b2928598360","user":{"login":"dkillick","id":3473068,"avatar_url":"https://gravatar.com/avatar/2133f83755a74b4a9eb04f6601345a26?d=https%3A%2F%2Fidenticons.github.com%2F118e18e3e0c7f76af673ac1f3388f2a1.png&r=x","gravatar_id":"2133f83755a74b4a9eb04f6601345a26","url":"https://api.github.com/users/dkillick","html_url":"https://github.com/dkillick","followers_url":"https://api.github.com/users/dkillick/followers","following_url":"https://api.github.com/users/dkillick/following{/other_user}","gists_url":"https://api.github.com/users/dkillick/gists{/gist_id}","starred_url":"https://api.github.com/users/dkillick/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dkillick/subscriptions","organizations_url":"https://api.github.com/users/dkillick/orgs","repos_url":"https://api.github.com/users/dkillick/repos","events_url":"https://api.github.com/users/dkillick/events{/privacy}","received_events_url":"https://api.github.com/users/dkillick/received_events","type":"User","site_admin":false},"body":"I might be missing the point of this remark, but it says [in the documentation above](https://github.com/SciTools/iris/blob/master/lib/iris/analysis/__init__.py#L424) that\r\n\r\n> \"[aggregate] is usually used in conjunction with update_metadata()...\"\r\n\r\nwhich seems to be in contradiction to this statement.\r\n\r\nGiven how much consternation there has been around our docs recently (especially due to `is_compatible`) I wonder if this should be clarified now?","created_at":"2014-02-11T15:28:51Z","updated_at":"2014-02-11T15:28:51Z","html_url":"https://github.com/SciTools/iris/pull/1022#discussion_r9627599","pull_request_url":"https://api.github.com/repos/SciTools/iris/pulls/1022","_links":{"self":{"href":"https://api.github.com/repos/SciTools/iris/pulls/comments/9627599"},"html":{"href":"https://github.com/SciTools/iris/pull/1022#discussion_r9627599"},"pull_request":{"href":"https://api.github.com/repos/SciTools/iris/pulls/1022"}}}}