GitHub PullRequestReviewCommentEvent at 2014-09-02 16:35:03
Repository: mongo-java-driver
Actor: jyemin
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/comments/16998650","id":16998650,"diff_hunk":"@@ -388,56 +415,54 @@ public DBCursor sort(final DBObject orderBy) {\n     }\n \n     /**\n-     * Limits the number of elements returned. Note: parameter <tt>n</tt> should be positive, although a negative value is supported for\n-     * legacy reason. Passing a negative value will call {@link DBCursor#batchSize(int)} which is the preferred method.\n+     * Limits the number of elements returned. Note: parameter {@code numberOfElements} should be positive, although a negative value is\n+     * supported for legacy reason. Passing a negative value will call {@link DBCursor#batchSize(int)} which is the preferred method.\n      *\n-     * @param n the number of elements to return\n+     * @param numberOfElements the number of elements to return\n      * @return a cursor to iterate the results\n      * @mongodb.driver.manual reference/method/cursor.limit Limit\n      */\n-    public DBCursor limit(final int n) {\n-        find.limit(n);\n+    public DBCursor limit(final int numberOfElements) {\n+        find.limit(numberOfElements);\n         return this;\n     }\n \n     /**\n-     * Limits the number of elements returned in one batch. A cursor typically fetches a batch of result objects and store them locally.\n-     * <p/>\n-     * If <tt>batchSize</tt> is positive, it represents the size of each batch of objects retrieved. It can be adjusted to optimize\n-     * performance and limit data transfer.\n-     * <p/>\n-     * If <tt>batchSize</tt> is negative, it will limit of number objects returned, that fit within the max batch size limit (usually 4MB),\n-     * and cursor will be closed. For example if <tt>batchSize</tt> is -10, then the server will return a maximum of 10 documents and as\n-     * many as can fit in 4MB, then close the cursor. Note that this feature is different from limit() in that documents must fit within a\n-     * maximum size, and it removes the need to send a request to close the cursor server-side.\n-     * <p/>\n-     * The batch size can be changed even after a cursor is iterated, in which case the setting will apply on the next batch retrieval.\n+     * <p>Limits the number of elements returned in one batch. A cursor typically fetches a batch of result objects and store them\n+     * locally.</p>\n+     *\n+     * <p>If {@code batchSize} is positive, it represents the size of each batch of objects retrieved. It can be adjusted to optimize\n+     * performance and limit data transfer.</p>\n      *\n-     * @param n the number of elements to return in a batch\n-     * @return {@code this}\n+     * <p>If {@code batchSize} is negative, it will limit of number objects returned, that fit within the max batch size limit (usually\n+     * 4MB), and cursor will be closed. For example if {@code batchSize} is -10, then the server will return a maximum of 10 documents and\n+     * as many as can fit in 4MB, then close the cursor. Note that this feature is different from limit() in that documents must fit within\n+     * a maximum size, and it removes the need to send a request to close the cursor server-side.</p>\n+     *\n+     * <p>The batch size can be changed even after a cursor is iterated, in which case the setting will apply on the next batch","path":"driver/src/main/com/mongodb/DBCursor.java","position":292,"original_position":292,"commit_id":"0872f640b8699542420799217cbfc8a6cd62d38f","original_commit_id":"0872f640b8699542420799217cbfc8a6cd62d38f","user":{"login":"jyemin","id":1111546,"avatar_url":"https://avatars.githubusercontent.com/u/1111546?v=2","gravatar_id":"f251069a82b44fe0aa645e6577660efc","url":"https://api.github.com/users/jyemin","html_url":"https://github.com/jyemin","followers_url":"https://api.github.com/users/jyemin/followers","following_url":"https://api.github.com/users/jyemin/following{/other_user}","gists_url":"https://api.github.com/users/jyemin/gists{/gist_id}","starred_url":"https://api.github.com/users/jyemin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jyemin/subscriptions","organizations_url":"https://api.github.com/users/jyemin/orgs","repos_url":"https://api.github.com/users/jyemin/repos","events_url":"https://api.github.com/users/jyemin/events{/privacy}","received_events_url":"https://api.github.com/users/jyemin/received_events","type":"User","site_admin":false},"body":"Take this paragraph out.  It's not true anymore.","created_at":"2014-09-02T16:35:03Z","updated_at":"2014-09-02T16:35:03Z","html_url":"https://github.com/mongodb/mongo-java-driver/pull/243#discussion_r16998650","pull_request_url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243","_links":{"self":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/comments/16998650"},"html":{"href":"https://github.com/mongodb/mongo-java-driver/pull/243#discussion_r16998650"},"pull_request":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243"}}},"pull_request":{"url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243","id":20575986,"html_url":"https://github.com/mongodb/mongo-java-driver/pull/243","diff_url":"https://github.com/mongodb/mongo-java-driver/pull/243.diff","patch_url":"https://github.com/mongodb/mongo-java-driver/pull/243.patch","issue_url":"https://api.github.com/repos/mongodb/mongo-java-driver/issues/243","number":243,"state":"open","locked":false,"title":"JAVA-1410: Javadoc for legacy API","user":{"login":"trishagee","id":1479352,"avatar_url":"https://avatars.githubusercontent.com/u/1479352?v=2","gravatar_id":"3d6ace9554821d552146413bcdf874f6","url":"https://api.github.com/users/trishagee","html_url":"https://github.com/trishagee","followers_url":"https://api.github.com/users/trishagee/followers","following_url":"https://api.github.com/users/trishagee/following{/other_user}","gists_url":"https://api.github.com/users/trishagee/gists{/gist_id}","starred_url":"https://api.github.com/users/trishagee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/trishagee/subscriptions","organizations_url":"https://api.github.com/users/trishagee/orgs","repos_url":"https://api.github.com/users/trishagee/repos","events_url":"https://api.github.com/users/trishagee/events{/privacy}","received_events_url":"https://api.github.com/users/trishagee/received_events","type":"User","site_admin":false},"body":"Made a first pass through the com.mongodb package and the existing API classes.  I've added some jira tickets for missing tests and code we might be able to delete, and updated the [Jira ticket](https://jira.mongodb.org/browse/JAVA-1410) with the classes that I couldn't document without help.","created_at":"2014-09-01T14:52:44Z","updated_at":"2014-09-02T16:35:03Z","closed_at":null,"merged_at":null,"merge_commit_sha":"03ac9b5f54dbe29d92a24f255d4ba47267737959","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243/commits","review_comments_url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243/comments","review_comment_url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/comments/{number}","comments_url":"https://api.github.com/repos/mongodb/mongo-java-driver/issues/243/comments","statuses_url":"https://api.github.com/repos/mongodb/mongo-java-driver/statuses/0872f640b8699542420799217cbfc8a6cd62d38f","head":{"label":"trishagee:JAVA-1410","ref":"JAVA-1410","sha":"0872f640b8699542420799217cbfc8a6cd62d38f","user":{"login":"trishagee","id":1479352,"avatar_url":"https://avatars.githubusercontent.com/u/1479352?v=2","gravatar_id":"3d6ace9554821d552146413bcdf874f6","url":"https://api.github.com/users/trishagee","html_url":"https://github.com/trishagee","followers_url":"https://api.github.com/users/trishagee/followers","following_url":"https://api.github.com/users/trishagee/following{/other_user}","gists_url":"https://api.github.com/users/trishagee/gists{/gist_id}","starred_url":"https://api.github.com/users/trishagee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/trishagee/subscriptions","organizations_url":"https://api.github.com/users/trishagee/orgs","repos_url":"https://api.github.com/users/trishagee/repos","events_url":"https://api.github.com/users/trishagee/events{/privacy}","received_events_url":"https://api.github.com/users/trishagee/received_events","type":"User","site_admin":false},"repo":{"id":5486608,"name":"mongo-java-driver","full_name":"trishagee/mongo-java-driver","owner":{"login":"trishagee","id":1479352,"avatar_url":"https://avatars.githubusercontent.com/u/1479352?v=2","gravatar_id":"3d6ace9554821d552146413bcdf874f6","url":"https://api.github.com/users/trishagee","html_url":"https://github.com/trishagee","followers_url":"https://api.github.com/users/trishagee/followers","following_url":"https://api.github.com/users/trishagee/following{/other_user}","gists_url":"https://api.github.com/users/trishagee/gists{/gist_id}","starred_url":"https://api.github.com/users/trishagee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/trishagee/subscriptions","organizations_url":"https://api.github.com/users/trishagee/orgs","repos_url":"https://api.github.com/users/trishagee/repos","events_url":"https://api.github.com/users/trishagee/events{/privacy}","received_events_url":"https://api.github.com/users/trishagee/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/trishagee/mongo-java-driver","description":"java driver for mongo","fork":true,"url":"https://api.github.com/repos/trishagee/mongo-java-driver","forks_url":"https://api.github.com/repos/trishagee/mongo-java-driver/forks","keys_url":"https://api.github.com/repos/trishagee/mongo-java-driver/keys{/key_id}","collaborators_url":"https://api.github.com/repos/trishagee/mongo-java-driver/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/trishagee/mongo-java-driver/teams","hooks_url":"https://api.github.com/repos/trishagee/mongo-java-driver/hooks","issue_events_url":"https://api.github.com/repos/trishagee/mongo-java-driver/issues/events{/number}","events_url":"https://api.github.com/repos/trishagee/mongo-java-driver/events","assignees_url":"https://api.github.com/repos/trishagee/mongo-java-driver/assignees{/user}","branches_url":"https://api.github.com/repos/trishagee/mongo-java-driver/branches{/branch}","tags_url":"https://api.github.com/repos/trishagee/mongo-java-driver/tags","blobs_url":"https://api.github.com/repos/trishagee/mongo-java-driver/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/trishagee/mongo-java-driver/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/trishagee/mongo-java-driver/git/refs{/sha}","trees_url":"https://api.github.com/repos/trishagee/mongo-java-driver/git/trees{/sha}","statuses_url":"https://api.github.com/repos/trishagee/mongo-java-driver/statuses/{sha}","languages_url":"https://api.github.com/repos/trishagee/mongo-java-driver/languages","stargazers_url":"https://api.github.com/repos/trishagee/mongo-java-driver/stargazers","contributors_url":"https://api.github.com/repos/trishagee/mongo-java-driver/contributors","subscribers_url":"https://api.github.com/repos/trishagee/mongo-java-driver/subscribers","subscription_url":"https://api.github.com/repos/trishagee/mongo-java-driver/subscription","commits_url":"https://api.github.com/repos/trishagee/mongo-java-driver/commits{/sha}","git_commits_url":"https://api.github.com/repos/trishagee/mongo-java-driver/git/commits{/sha}","comments_url":"https://api.github.com/repos/trishagee/mongo-java-driver/comments{/number}","issue_comment_url":"https://api.github.com/repos/trishagee/mongo-java-driver/issues/comments/{number}","contents_url":"https://api.github.com/repos/trishagee/mongo-java-driver/contents/{+path}","compare_url":"https://api.github.com/repos/trishagee/mongo-java-driver/compare/{base}...{head}","merges_url":"https://api.github.com/repos/trishagee/mongo-java-driver/merges","archive_url":"https://api.github.com/repos/trishagee/mongo-java-driver/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/trishagee/mongo-java-driver/downloads","issues_url":"https://api.github.com/repos/trishagee/mongo-java-driver/issues{/number}","pulls_url":"https://api.github.com/repos/trishagee/mongo-java-driver/pulls{/number}","milestones_url":"https://api.github.com/repos/trishagee/mongo-java-driver/milestones{/number}","notifications_url":"https://api.github.com/repos/trishagee/mongo-java-driver/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/trishagee/mongo-java-driver/labels{/name}","releases_url":"https://api.github.com/repos/trishagee/mongo-java-driver/releases{/id}","created_at":"2012-08-20T20:47:56Z","updated_at":"2014-06-25T08:03:17Z","pushed_at":"2014-09-02T11:07:00Z","git_url":"git://github.com/trishagee/mongo-java-driver.git","ssh_url":"git@github.com:trishagee/mongo-java-driver.git","clone_url":"https://github.com/trishagee/mongo-java-driver.git","svn_url":"https://github.com/trishagee/mongo-java-driver","homepage":"","size":26864,"stargazers_count":2,"watchers_count":2,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":true,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":2,"default_branch":"master"}},"base":{"label":"mongodb:3.0.x","ref":"3.0.x","sha":"6f9513ae6f7d79baf3eb7ab3dfafc82d7d9daa75","user":{"login":"mongodb","id":45120,"avatar_url":"https://avatars.githubusercontent.com/u/45120?v=2","gravatar_id":"c17ac52a9e94e768c4fab0ce37065841","url":"https://api.github.com/users/mongodb","html_url":"https://github.com/mongodb","followers_url":"https://api.github.com/users/mongodb/followers","following_url":"https://api.github.com/users/mongodb/following{/other_user}","gists_url":"https://api.github.com/users/mongodb/gists{/gist_id}","starred_url":"https://api.github.com/users/mongodb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mongodb/subscriptions","organizations_url":"https://api.github.com/users/mongodb/orgs","repos_url":"https://api.github.com/users/mongodb/repos","events_url":"https://api.github.com/users/mongodb/events{/privacy}","received_events_url":"https://api.github.com/users/mongodb/received_events","type":"Organization","site_admin":false},"repo":{"id":108050,"name":"mongo-java-driver","full_name":"mongodb/mongo-java-driver","owner":{"login":"mongodb","id":45120,"avatar_url":"https://avatars.githubusercontent.com/u/45120?v=2","gravatar_id":"c17ac52a9e94e768c4fab0ce37065841","url":"https://api.github.com/users/mongodb","html_url":"https://github.com/mongodb","followers_url":"https://api.github.com/users/mongodb/followers","following_url":"https://api.github.com/users/mongodb/following{/other_user}","gists_url":"https://api.github.com/users/mongodb/gists{/gist_id}","starred_url":"https://api.github.com/users/mongodb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mongodb/subscriptions","organizations_url":"https://api.github.com/users/mongodb/orgs","repos_url":"https://api.github.com/users/mongodb/repos","events_url":"https://api.github.com/users/mongodb/events{/privacy}","received_events_url":"https://api.github.com/users/mongodb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mongodb/mongo-java-driver","description":"The Java driver for MongoDB ","fork":false,"url":"https://api.github.com/repos/mongodb/mongo-java-driver","forks_url":"https://api.github.com/repos/mongodb/mongo-java-driver/forks","keys_url":"https://api.github.com/repos/mongodb/mongo-java-driver/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mongodb/mongo-java-driver/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mongodb/mongo-java-driver/teams","hooks_url":"https://api.github.com/repos/mongodb/mongo-java-driver/hooks","issue_events_url":"https://api.github.com/repos/mongodb/mongo-java-driver/issues/events{/number}","events_url":"https://api.github.com/repos/mongodb/mongo-java-driver/events","assignees_url":"https://api.github.com/repos/mongodb/mongo-java-driver/assignees{/user}","branches_url":"https://api.github.com/repos/mongodb/mongo-java-driver/branches{/branch}","tags_url":"https://api.github.com/repos/mongodb/mongo-java-driver/tags","blobs_url":"https://api.github.com/repos/mongodb/mongo-java-driver/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mongodb/mongo-java-driver/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mongodb/mongo-java-driver/git/refs{/sha}","trees_url":"https://api.github.com/repos/mongodb/mongo-java-driver/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mongodb/mongo-java-driver/statuses/{sha}","languages_url":"https://api.github.com/repos/mongodb/mongo-java-driver/languages","stargazers_url":"https://api.github.com/repos/mongodb/mongo-java-driver/stargazers","contributors_url":"https://api.github.com/repos/mongodb/mongo-java-driver/contributors","subscribers_url":"https://api.github.com/repos/mongodb/mongo-java-driver/subscribers","subscription_url":"https://api.github.com/repos/mongodb/mongo-java-driver/subscription","commits_url":"https://api.github.com/repos/mongodb/mongo-java-driver/commits{/sha}","git_commits_url":"https://api.github.com/repos/mongodb/mongo-java-driver/git/commits{/sha}","comments_url":"https://api.github.com/repos/mongodb/mongo-java-driver/comments{/number}","issue_comment_url":"https://api.github.com/repos/mongodb/mongo-java-driver/issues/comments/{number}","contents_url":"https://api.github.com/repos/mongodb/mongo-java-driver/contents/{+path}","compare_url":"https://api.github.com/repos/mongodb/mongo-java-driver/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mongodb/mongo-java-driver/merges","archive_url":"https://api.github.com/repos/mongodb/mongo-java-driver/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mongodb/mongo-java-driver/downloads","issues_url":"https://api.github.com/repos/mongodb/mongo-java-driver/issues{/number}","pulls_url":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls{/number}","milestones_url":"https://api.github.com/repos/mongodb/mongo-java-driver/milestones{/number}","notifications_url":"https://api.github.com/repos/mongodb/mongo-java-driver/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mongodb/mongo-java-driver/labels{/name}","releases_url":"https://api.github.com/repos/mongodb/mongo-java-driver/releases{/id}","created_at":"2009-01-15T15:16:29Z","updated_at":"2014-09-02T10:11:53Z","pushed_at":"2014-09-02T09:54:27Z","git_url":"git://github.com/mongodb/mongo-java-driver.git","ssh_url":"git@github.com:mongodb/mongo-java-driver.git","clone_url":"https://github.com/mongodb/mongo-java-driver.git","svn_url":"https://github.com/mongodb/mongo-java-driver","homepage":"http://api.mongodb.org/java/current","size":38378,"stargazers_count":1021,"watchers_count":1021,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":true,"forks_count":571,"mirror_url":null,"open_issues_count":17,"forks":571,"open_issues":17,"watchers":1021,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243"},"html":{"href":"https://github.com/mongodb/mongo-java-driver/pull/243"},"issue":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/issues/243"},"comments":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/issues/243/comments"},"review_comments":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243/comments"},"review_comment":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/pulls/243/commits"},"statuses":{"href":"https://api.github.com/repos/mongodb/mongo-java-driver/statuses/0872f640b8699542420799217cbfc8a6cd62d38f"}}}}